From 4f1764f7a0203e3723361d84203719f1ea630278 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sat, 4 Sep 2010 18:13:18 +0000
Subject: [PATCH] * added file description headers * changed a @ingroup Media
 to FileRepo

---
 includes/filerepo/ArchivedFile.php          | 13 ++++++++++---
 includes/filerepo/FSRepo.php                |  6 ++++++
 includes/filerepo/File.php                  |  6 ++++++
 includes/filerepo/FileRepo.php              |  9 ++++++++-
 includes/filerepo/FileRepoStatus.php        |  6 ++++++
 includes/filerepo/ForeignAPIFile.php        | 12 +++++++++---
 includes/filerepo/ForeignAPIRepo.php        |  6 ++++++
 includes/filerepo/ForeignDBFile.php         |  8 ++++++++
 includes/filerepo/ForeignDBRepo.php         |  7 +++++++
 includes/filerepo/ForeignDBViaLBRepo.php    |  7 +++++++
 includes/filerepo/Image.php                 |  6 ++++++
 includes/filerepo/LocalFile.php             |  4 ++++
 includes/filerepo/LocalRepo.php             |  8 ++++++++
 includes/filerepo/NullRepo.php              |  6 ++++++
 includes/filerepo/OldLocalFile.php          |  6 ++++++
 includes/filerepo/RepoGroup.php             |  9 +++++++--
 includes/filerepo/UnregisteredLocalFile.php |  6 ++++++
 17 files changed, 116 insertions(+), 9 deletions(-)

diff --git a/includes/filerepo/ArchivedFile.php b/includes/filerepo/ArchivedFile.php
index 5db915bfbc..ecc0997851 100644
--- a/includes/filerepo/ArchivedFile.php
+++ b/includes/filerepo/ArchivedFile.php
@@ -1,10 +1,17 @@
 <?php
+/**
+ * Deleted file in the 'filearchive' table
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
- * @ingroup Media
+ * Class representing a row of the 'filearchive' table
+ *
+ * @ingroup FileRepo
  */
-class ArchivedFile
-{
+class ArchivedFile {
 	/**#@+
 	 * @private
 	 */
diff --git a/includes/filerepo/FSRepo.php b/includes/filerepo/FSRepo.php
index 68f175e928..e2251b2bac 100644
--- a/includes/filerepo/FSRepo.php
+++ b/includes/filerepo/FSRepo.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * A repository for files accessible via the local filesystem.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * A repository for files accessible via the local filesystem. Does not support
diff --git a/includes/filerepo/File.php b/includes/filerepo/File.php
index 2e3fcefa12..6b7dcf8a13 100644
--- a/includes/filerepo/File.php
+++ b/includes/filerepo/File.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Base code for files.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * Implements some public methods and some protected utility functions which
diff --git a/includes/filerepo/FileRepo.php b/includes/filerepo/FileRepo.php
index b6b3b8a3cc..c65b4038d0 100644
--- a/includes/filerepo/FileRepo.php
+++ b/includes/filerepo/FileRepo.php
@@ -1,8 +1,15 @@
 <?php
+/**
+ * Base code for file repositories.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
- * Base class for file repositories
+ * Base class for file repositories.
  * Do not instantiate, use a derived class.
+ *
  * @ingroup FileRepo
  */
 abstract class FileRepo {
diff --git a/includes/filerepo/FileRepoStatus.php b/includes/filerepo/FileRepoStatus.php
index 63460fa8fd..161284c01c 100644
--- a/includes/filerepo/FileRepoStatus.php
+++ b/includes/filerepo/FileRepoStatus.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Generic operation result for FileRepo-related operations
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * Generic operation result class for FileRepo-related operations
diff --git a/includes/filerepo/ForeignAPIFile.php b/includes/filerepo/ForeignAPIFile.php
index 7c33a49809..464a852e57 100644
--- a/includes/filerepo/ForeignAPIFile.php
+++ b/includes/filerepo/ForeignAPIFile.php
@@ -1,8 +1,14 @@
 <?php
+/**
+ * Foreign file accessible through api.php requests.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
-/** 
- * Very hacky and inefficient
- * do not use :D
+/**
+ * Foreign file accessible through api.php requests.
+ * Very hacky and inefficient, do not use :D
  *
  * @ingroup FileRepo
  */
diff --git a/includes/filerepo/ForeignAPIRepo.php b/includes/filerepo/ForeignAPIRepo.php
index 24c7a92d09..094258bb24 100644
--- a/includes/filerepo/ForeignAPIRepo.php
+++ b/includes/filerepo/ForeignAPIRepo.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Foreign repository accessible through api.php requests.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * A foreign repository with a remote MediaWiki with an API thingy
diff --git a/includes/filerepo/ForeignDBFile.php b/includes/filerepo/ForeignDBFile.php
index 83c12f9d55..34a11cc29c 100644
--- a/includes/filerepo/ForeignDBFile.php
+++ b/includes/filerepo/ForeignDBFile.php
@@ -1,6 +1,14 @@
 <?php
+/**
+ * Foreign file with an accessible MediaWiki database
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
+ * Foreign file with an accessible MediaWiki database
+ *
  * @ingroup FileRepo
  */
 class ForeignDBFile extends LocalFile {
diff --git a/includes/filerepo/ForeignDBRepo.php b/includes/filerepo/ForeignDBRepo.php
index df3fde90b5..35f93d889a 100644
--- a/includes/filerepo/ForeignDBRepo.php
+++ b/includes/filerepo/ForeignDBRepo.php
@@ -1,7 +1,14 @@
 <?php
+/**
+ * A foreign repository with an accessible MediaWiki database
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * A foreign repository with an accessible MediaWiki database
+ *
  * @ingroup FileRepo
  */
 class ForeignDBRepo extends LocalRepo {
diff --git a/includes/filerepo/ForeignDBViaLBRepo.php b/includes/filerepo/ForeignDBViaLBRepo.php
index 803257521e..4c530b511d 100644
--- a/includes/filerepo/ForeignDBViaLBRepo.php
+++ b/includes/filerepo/ForeignDBViaLBRepo.php
@@ -1,7 +1,14 @@
 <?php
+/**
+ * A foreign repository with a MediaWiki database accessible via the configured LBFactory
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * A foreign repository with a MediaWiki database accessible via the configured LBFactory
+ *
  * @ingroup FileRepo
  */
 class ForeignDBViaLBRepo extends LocalRepo {
diff --git a/includes/filerepo/Image.php b/includes/filerepo/Image.php
index 18643f86db..799421ae6e 100644
--- a/includes/filerepo/Image.php
+++ b/includes/filerepo/Image.php
@@ -1,7 +1,13 @@
 <?php
+/**
+ * Backward compatibility code for MW < 1.11
+ *
+ * @file
+ */
 
 /**
  * Backwards compatibility class
+ *
  * @deprecated
  * @ingroup FileRepo
  */
diff --git a/includes/filerepo/LocalFile.php b/includes/filerepo/LocalFile.php
index 67ab6e9d75..24beb30f34 100644
--- a/includes/filerepo/LocalFile.php
+++ b/includes/filerepo/LocalFile.php
@@ -1,5 +1,9 @@
 <?php
 /**
+ * Local file in the wiki's own database
+ *
+ * @file
+ * @ingroup FileRepo
  */
 
 /**
diff --git a/includes/filerepo/LocalRepo.php b/includes/filerepo/LocalRepo.php
index 62386a110d..96ec28f215 100644
--- a/includes/filerepo/LocalRepo.php
+++ b/includes/filerepo/LocalRepo.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Local repository that stores files in the local filesystem and registers them
+ * in the wiki's own database.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
+
 /**
  * A repository that stores files in the local filesystem and registers them
  * in the wiki's own database. This is the most commonly used repository class.
diff --git a/includes/filerepo/NullRepo.php b/includes/filerepo/NullRepo.php
index 2bc61bdec8..d5a1ee03db 100644
--- a/includes/filerepo/NullRepo.php
+++ b/includes/filerepo/NullRepo.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * File repository with no files.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * File repository with no files, for performance testing
diff --git a/includes/filerepo/OldLocalFile.php b/includes/filerepo/OldLocalFile.php
index 7769271891..d80e896c9f 100644
--- a/includes/filerepo/OldLocalFile.php
+++ b/includes/filerepo/OldLocalFile.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Old file in the in the oldimage table
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * Class to represent a file in the oldimage table
diff --git a/includes/filerepo/RepoGroup.php b/includes/filerepo/RepoGroup.php
index 2594a8f390..8dae87cb52 100644
--- a/includes/filerepo/RepoGroup.php
+++ b/includes/filerepo/RepoGroup.php
@@ -1,14 +1,19 @@
 <?php
 /**
- * @defgroup FileRepo FileRepo
+ * Prioritized list of file repositories
  *
  * @file
  * @ingroup FileRepo
  */
 
 /**
- * @ingroup FileRepo
+ * @defgroup FileRepo FileRepo
+ */
+
+/**
  * Prioritized list of file repositories
+ *
+ * @ingroup FileRepo
  */
 class RepoGroup {
 	var $localRepo, $foreignRepos, $reposInitialised = false;
diff --git a/includes/filerepo/UnregisteredLocalFile.php b/includes/filerepo/UnregisteredLocalFile.php
index 6f63cb0bca..99f6913f3e 100644
--- a/includes/filerepo/UnregisteredLocalFile.php
+++ b/includes/filerepo/UnregisteredLocalFile.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * File without associated database record
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * A file object referring to either a standalone local file, or a file in a
-- 
2.20.1