r60911 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r60910‎ | r60911 | r60912 >
Date:21:39, 10 January 2010
Author:ialex
Status:ok
Tags:
Comment:
* Added new doxygen group "ExternalUser"
* Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/ExternalUser.php (modified) (history)
  • /trunk/phase3/includes/extauth/Hardcoded.php (modified) (history)
  • /trunk/phase3/includes/extauth/MediaWiki.php (modified) (history)
  • /trunk/phase3/includes/extauth/vB.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/ExternalUser.php
@@ -18,6 +18,10 @@
1919 # http://www.gnu.org/copyleft/gpl.html
2020
2121 /**
 22+ * @defgroup ExternalUser ExternalUser
 23+ */
 24+
 25+/**
2226 * A class intended to supplement, and perhaps eventually replace, AuthPlugin.
2327 * See: http://www.mediawiki.org/wiki/ExternalAuth
2428 *
@@ -26,6 +30,8 @@
2731 * assumed to at least support the concept of a user id (possibly not an
2832 * integer), a user name (possibly not meeting MediaWiki's username
2933 * requirements), and a password.
 34+ *
 35+ * @ingroup ExternalUser
3036 */
3137 abstract class ExternalUser {
3238 protected function __construct() {}
@@ -67,7 +73,6 @@
6874 }
6975
7076 /**
71 - * @param $cookie string
7277 * @return mixed ExternalUser, or false on failure
7378 */
7479 public static function newFromCookie() {
Index: trunk/phase3/includes/extauth/Hardcoded.php
@@ -31,6 +31,8 @@
3232 *
3333 * Multiple names may be provided. The keys of the inner arrays can be either
3434 * 'password', or the name of any preference.
 35+ *
 36+ * @ingroup ExternalUser
3537 */
3638 class ExternalUser_Hardcoded extends ExternalUser {
3739 private $mName;
Index: trunk/phase3/includes/extauth/MediaWiki.php
@@ -41,6 +41,8 @@
4242 * might fail unexpectedly unless they both do the exact same validation.
4343 * There may be other corner cases like this where this will fail, but it
4444 * should be unlikely.
 45+ *
 46+ * @ingroup ExternalUser
4547 */
4648 class ExternalUser_MediaWiki extends ExternalUser {
4749 private $mRow, $mDb;
Index: trunk/phase3/includes/extauth/vB.php
@@ -32,6 +32,8 @@
3333 * 'tableprefix' => '',
3434 * 'cookieprefix' => 'bb'
3535 * );
 36+ *
 37+ * @ingroup ExternalUser
3638 */
3739 class ExternalUser_vB extends ExternalUser {
3840 private $mDb, $mRow;

Status & tagging log