Improved documentation
This commit is contained in:
parent
acbe9ebf9e
commit
126e281165
|
@ -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
|
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
|
||||||
*
|
*
|
||||||
|
|
|
@ -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
|
* @return int User ID
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue