From 3349537c11f2204de8cd0159c57a80ad17448e60 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sun, 10 Jan 2010 21:39:47 +0000
Subject: [PATCH] * Added new doxygen group "ExternalUser" * Fixed some doxygen
 warnings

---
 includes/ExternalUser.php      | 7 ++++++-
 includes/extauth/Hardcoded.php | 2 ++
 includes/extauth/MediaWiki.php | 2 ++
 includes/extauth/vB.php        | 2 ++
 4 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/includes/ExternalUser.php b/includes/ExternalUser.php
index e89c205da7..65dae61795 100644
--- a/includes/ExternalUser.php
+++ b/includes/ExternalUser.php
@@ -17,6 +17,10 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 # 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 7330aa14bd..a9a60beaf3 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 4b4553bd8b..7d6a3c7184 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 39cd2a2c85..23523665fe 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;
-- 
2.20.1