diff options
author | Alexandre Emsenhuber <ialex@users.mediawiki.org> | 2010-01-10 21:39:47 +0000 |
---|---|---|
committer | Alexandre Emsenhuber <ialex@users.mediawiki.org> | 2010-01-10 21:39:47 +0000 |
commit | 3349537c11f2204de8cd0159c57a80ad17448e60 (patch) | |
tree | b1c7068187a34fdf918efe79e9bdc16647ecb1e9 | |
parent | f602f562e1f7ecb11cbebedb9af64c7dddafb7c9 (diff) | |
download | mediawikicore-3349537c11f2204de8cd0159c57a80ad17448e60.tar.gz mediawikicore-3349537c11f2204de8cd0159c57a80ad17448e60.zip |
* Added new doxygen group "ExternalUser"
* Fixed some doxygen warnings
Notes
Notes:
http://mediawiki.org/wiki/Special:Code/MediaWiki/60911
-rw-r--r-- | includes/ExternalUser.php | 7 | ||||
-rw-r--r-- | includes/extauth/Hardcoded.php | 2 | ||||
-rw-r--r-- | includes/extauth/MediaWiki.php | 2 | ||||
-rw-r--r-- | includes/extauth/vB.php | 2 |
4 files changed, 12 insertions, 1 deletions
diff --git a/includes/ExternalUser.php b/includes/ExternalUser.php index e89c205da72a..65dae6179523 100644 --- a/includes/ExternalUser.php +++ b/includes/ExternalUser.php @@ -18,6 +18,10 @@ # http://www.gnu.org/copyleft/gpl.html /** + * @defgroup ExternalUser ExternalUser + */ + +/** * A class intended to supplement, and perhaps eventually replace, AuthPlugin. * See: http://www.mediawiki.org/wiki/ExternalAuth * @@ -26,6 +30,8 @@ * assumed to at least support the concept of a user id (possibly not an * integer), a user name (possibly not meeting MediaWiki's username * requirements), and a password. + * + * @ingroup ExternalUser */ abstract class ExternalUser { protected function __construct() {} @@ -67,7 +73,6 @@ abstract class ExternalUser { } /** - * @param $cookie string * @return mixed ExternalUser, or false on failure */ public static function newFromCookie() { diff --git a/includes/extauth/Hardcoded.php b/includes/extauth/Hardcoded.php index 7330aa14bda9..a9a60beaf399 100644 --- a/includes/extauth/Hardcoded.php +++ b/includes/extauth/Hardcoded.php @@ -31,6 +31,8 @@ * * Multiple names may be provided. The keys of the inner arrays can be either * 'password', or the name of any preference. + * + * @ingroup ExternalUser */ class ExternalUser_Hardcoded extends ExternalUser { private $mName; diff --git a/includes/extauth/MediaWiki.php b/includes/extauth/MediaWiki.php index 4b4553bd8b53..7d6a3c7184cf 100644 --- a/includes/extauth/MediaWiki.php +++ b/includes/extauth/MediaWiki.php @@ -41,6 +41,8 @@ * might fail unexpectedly unless they both do the exact same validation. * There may be other corner cases like this where this will fail, but it * should be unlikely. + * + * @ingroup ExternalUser */ class ExternalUser_MediaWiki extends ExternalUser { private $mRow, $mDb; diff --git a/includes/extauth/vB.php b/includes/extauth/vB.php index 39cd2a2c8578..23523665fe68 100644 --- a/includes/extauth/vB.php +++ b/includes/extauth/vB.php @@ -32,6 +32,8 @@ * 'tableprefix' => '', * 'cookieprefix' => 'bb' * ); + * + * @ingroup ExternalUser */ class ExternalUser_vB extends ExternalUser { private $mDb, $mRow; |