From fb36e6ac3e1adf1b1c47aa380217d50d4048baa4 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sun, 8 Aug 2010 11:55:47 +0000
Subject: [PATCH] * standardised file headers * added a basic description *
 added @file

---
 includes/db/LBFactory.php             |  2 ++
 includes/db/LBFactory_Multi.php       |  2 ++
 includes/db/LoadBalancer.php          |  2 ++
 includes/db/LoadMonitor.php           | 12 +++++++--
 includes/diff/Diff.php                |  8 +++++-
 includes/diff/DifferenceEngine.php    | 13 ++++-----
 includes/diff/DifferenceInterface.php |  5 +++-
 includes/extauth/Hardcoded.php        | 39 +++++++++++++++------------
 includes/extauth/MediaWiki.php        | 39 +++++++++++++++------------
 includes/extauth/vB.php               | 39 +++++++++++++++------------
 10 files changed, 100 insertions(+), 61 deletions(-)

diff --git a/includes/db/LBFactory.php b/includes/db/LBFactory.php
index d6295452a0..8f28a2a181 100644
--- a/includes/db/LBFactory.php
+++ b/includes/db/LBFactory.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Database load balancing
+ *
  * @file
  * @ingroup Database
  */
diff --git a/includes/db/LBFactory_Multi.php b/includes/db/LBFactory_Multi.php
index 820aa2ea1b..9eb7b90762 100644
--- a/includes/db/LBFactory_Multi.php
+++ b/includes/db/LBFactory_Multi.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Advanced database load balancing for wiki farms
+ *
  * @file
  * @ingroup Database
  */
diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php
index c4f31e8ba2..30f76b78b8 100644
--- a/includes/db/LoadBalancer.php
+++ b/includes/db/LoadBalancer.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Database load balancing
+ *
  * @file
  * @ingroup Database
  */
diff --git a/includes/db/LoadMonitor.php b/includes/db/LoadMonitor.php
index 13a98e5ded..9b959728c3 100644
--- a/includes/db/LoadMonitor.php
+++ b/includes/db/LoadMonitor.php
@@ -1,9 +1,16 @@
 <?php
+/**
+ * Database load monitoring
+ *
+ * @file
+ * @ingroup Database
+ */
 
 /**
  * An interface for database load monitoring
+ *
+ * @ingroup Database
  */
-
 interface LoadMonitor {
 	/**
 	 * Construct a new LoadMonitor with a given LoadBalancer parent
@@ -46,8 +53,9 @@ interface LoadMonitor {
 /**
  * Basic MySQL load monitor with no external dependencies
  * Uses memcached to cache the replication lag for a short time
+ *
+ * @ingroup Database
  */
-
 class LoadMonitor_MySQL implements LoadMonitor {
 	var $parent; // LoadBalancer
 
diff --git a/includes/diff/Diff.php b/includes/diff/Diff.php
index a1826d3f7f..b66958a7bb 100644
--- a/includes/diff/Diff.php
+++ b/includes/diff/Diff.php
@@ -1,5 +1,8 @@
 <?php
-/* Copyright (C) 2008 Guy Van den Broeck <guy@guyvdb.eu>
+/**
+ * New version of the difference engine
+ *
+ * Copyright © 2008 Guy Van den Broeck <guy@guyvdb.eu>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,6 +18,9 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup DifferenceEngine
  */
 
 /**
diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php
index 3364531243..1c9c2c9a2c 100644
--- a/includes/diff/DifferenceEngine.php
+++ b/includes/diff/DifferenceEngine.php
@@ -1,14 +1,15 @@
 <?php
 /**
+ * A PHP diff engine for phpwiki. (Taken from phpwiki-1.3.3)
+ *
+ * Copyright © 2000, 2001 Geoffrey T. Dairiki <dairiki@dairiki.org>
+ * You may copy this code freely under the conditions of the GPL.
+ *
+ * @file
+ * @ingroup DifferenceEngine
  * @defgroup DifferenceEngine DifferenceEngine
  */
 
-// A PHP diff engine for phpwiki. (Taken from phpwiki-1.3.3)
-//
-// Copyright (C) 2000, 2001 Geoffrey T. Dairiki <dairiki@dairiki.org>
-// You may copy this code freely under the conditions of the GPL.
-//
-
 /**
  * @todo document
  * @private
diff --git a/includes/diff/DifferenceInterface.php b/includes/diff/DifferenceInterface.php
index bb210eca89..ba2a6da740 100644
--- a/includes/diff/DifferenceInterface.php
+++ b/includes/diff/DifferenceInterface.php
@@ -1,6 +1,9 @@
 <?php
 /**
- * @defgroup DifferenceEngine DifferenceEngine
+ * User interface for the difference engine
+ *
+ * @file
+ * @ingroup DifferenceEngine
  */
  
 /**
diff --git a/includes/extauth/Hardcoded.php b/includes/extauth/Hardcoded.php
index a9a60beaf3..dfb4674299 100644
--- a/includes/extauth/Hardcoded.php
+++ b/includes/extauth/Hardcoded.php
@@ -1,21 +1,26 @@
 <?php
-
-# Copyright (C) 2009 Aryeh Gregor
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * External authentication with hardcoded user names and passwords
+ *
+ * Copyright © 2009 Aryeh Gregor
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * This class supports external authentication from a literal array dumped in
diff --git a/includes/extauth/MediaWiki.php b/includes/extauth/MediaWiki.php
index 7d6a3c7184..749fcd6b9b 100644
--- a/includes/extauth/MediaWiki.php
+++ b/includes/extauth/MediaWiki.php
@@ -1,21 +1,26 @@
 <?php
-
-# Copyright (C) 2009 Aryeh Gregor
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * External authentication with external MediaWiki database.
+ *
+ * Copyright © 2009 Aryeh Gregor
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * This class supports authentication against an external MediaWiki database,
diff --git a/includes/extauth/vB.php b/includes/extauth/vB.php
index ac03fa06b4..1b015bae77 100644
--- a/includes/extauth/vB.php
+++ b/includes/extauth/vB.php
@@ -1,21 +1,26 @@
 <?php
-
-# Copyright (C) 2009 Aryeh Gregor
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * External authentication with a vBulletin database.
+ *
+ * Copyright © 2009 Aryeh Gregor
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * This class supports the proprietary vBulletin forum system
-- 
2.20.1