Improved documentation

diff --git a/src/Module/BaseApi.php b/src/Module/BaseApi.php
index e629ad99109f711a4caacd3924b31c0455c886b5..855f6ac23f203d79a90cd449618504f1b5041f93 100644 (file)
--- a/src/Module/BaseApi.php
+++ b/src/Module/BaseApi.php
@@ -173,7 +173,7 @@ class BaseApi extends BaseModule
        }
 
        /**
-        * Log in user via OAuth1 or Simple HTTP Auth.
+        * Log in user via OAuth or Simple HTTP Auth.
         *
         * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
         *

diff --git a/src/Security/BasicAuth.php b/src/Security/BasicAuth.php
index 002ecd6eb3ca461117c944b7de8718c6cc29b8b1..42e6d824c726d7b3449f3e222419f11daf881c76 100644 (file)
--- a/src/Security/BasicAuth.php
+++ b/src/Security/BasicAuth.php
@@ -68,7 +68,10 @@ class BasicAuth
        }
 
        /**
-        * Get current user id, returns 0 if not logged in
+        * Get current user id, returns 0 if $login is set to false and not logged in.
+        * When $login is true, the execution will stop when not logged in.
+        *
+        * @param bool $login Perform a login request if "true"
         *
         * @return int User ID
         */