* added file description headers
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 4 Sep 2010 18:13:18 +0000 (18:13 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 4 Sep 2010 18:13:18 +0000 (18:13 +0000)
* changed a @ingroup Media to FileRepo

17 files changed:
includes/filerepo/ArchivedFile.php
includes/filerepo/FSRepo.php
includes/filerepo/File.php
includes/filerepo/FileRepo.php
includes/filerepo/FileRepoStatus.php
includes/filerepo/ForeignAPIFile.php
includes/filerepo/ForeignAPIRepo.php
includes/filerepo/ForeignDBFile.php
includes/filerepo/ForeignDBRepo.php
includes/filerepo/ForeignDBViaLBRepo.php
includes/filerepo/Image.php
includes/filerepo/LocalFile.php
includes/filerepo/LocalRepo.php
includes/filerepo/NullRepo.php
includes/filerepo/OldLocalFile.php
includes/filerepo/RepoGroup.php
includes/filerepo/UnregisteredLocalFile.php

index 5db915b..ecc0997 100644 (file)
@@ -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
         */
index 68f175e..e2251b2 100644 (file)
@@ -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
index 2e3fcef..6b7dcf8 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Base code for files.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * Implements some public methods and some protected utility functions which
index b6b3b8a..c65b403 100644 (file)
@@ -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 {
index 63460fa..161284c 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Generic operation result for FileRepo-related operations
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * Generic operation result class for FileRepo-related operations
index 7c33a49..464a852 100644 (file)
@@ -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
  */
index 24c7a92..094258b 100644 (file)
@@ -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
index 83c12f9..34a11cc 100644 (file)
@@ -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 {
index df3fde9..35f93d8 100644 (file)
@@ -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 {
index 8032575..4c530b5 100644 (file)
@@ -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 {
index 18643f8..799421a 100644 (file)
@@ -1,7 +1,13 @@
 <?php
+/**
+ * Backward compatibility code for MW < 1.11
+ *
+ * @file
+ */
 
 /**
  * Backwards compatibility class
+ *
  * @deprecated
  * @ingroup FileRepo
  */
index 67ab6e9..24beb30 100644 (file)
@@ -1,5 +1,9 @@
 <?php
 /**
+ * Local file in the wiki's own database
+ *
+ * @file
+ * @ingroup FileRepo
  */
 
 /**
index 62386a1..96ec28f 100644 (file)
@@ -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.
index 2bc61bd..d5a1ee0 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * File repository with no files.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
 
 /**
  * File repository with no files, for performance testing
index 7769271..d80e896 100644 (file)
@@ -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
index 2594a8f..8dae87c 100644 (file)
@@ -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;
index 6f63cb0..99f6913 100644 (file)
@@ -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