http://www.mediawiki.org/wiki/Special:Code/MediaWiki/72385
Revision: 72385
Author: ialex
Date: 2010-09-04 18:13:18 +0000 (Sat, 04 Sep 2010)
Log Message:
-----------
* added file description headers
* changed a @ingroup Media to FileRepo
Modified Paths:
--------------
trunk/phase3/includes/filerepo/ArchivedFile.php
trunk/phase3/includes/filerepo/FSRepo.php
trunk/phase3/includes/filerepo/File.php
trunk/phase3/includes/filerepo/FileRepo.php
trunk/phase3/includes/filerepo/FileRepoStatus.php
trunk/phase3/includes/filerepo/ForeignAPIFile.php
trunk/phase3/includes/filerepo/ForeignAPIRepo.php
trunk/phase3/includes/filerepo/ForeignDBFile.php
trunk/phase3/includes/filerepo/ForeignDBRepo.php
trunk/phase3/includes/filerepo/ForeignDBViaLBRepo.php
trunk/phase3/includes/filerepo/Image.php
trunk/phase3/includes/filerepo/LocalFile.php
trunk/phase3/includes/filerepo/LocalRepo.php
trunk/phase3/includes/filerepo/NullRepo.php
trunk/phase3/includes/filerepo/OldLocalFile.php
trunk/phase3/includes/filerepo/RepoGroup.php
trunk/phase3/includes/filerepo/UnregisteredLocalFile.php
Modified: trunk/phase3/includes/filerepo/ArchivedFile.php
===================================================================
--- trunk/phase3/includes/filerepo/ArchivedFile.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/ArchivedFile.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -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
*/
Modified: trunk/phase3/includes/filerepo/FSRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/FSRepo.php 2010-09-04 17:46:30 UTC (rev
72384)
+++ trunk/phase3/includes/filerepo/FSRepo.php 2010-09-04 18:13:18 UTC (rev
72385)
@@ -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
Modified: trunk/phase3/includes/filerepo/File.php
===================================================================
--- trunk/phase3/includes/filerepo/File.php 2010-09-04 17:46:30 UTC (rev
72384)
+++ trunk/phase3/includes/filerepo/File.php 2010-09-04 18:13:18 UTC (rev
72385)
@@ -1,4 +1,10 @@
<?php
+/**
+ * Base code for files.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
/**
* Implements some public methods and some protected utility functions which
Modified: trunk/phase3/includes/filerepo/FileRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/FileRepo.php 2010-09-04 17:46:30 UTC (rev
72384)
+++ trunk/phase3/includes/filerepo/FileRepo.php 2010-09-04 18:13:18 UTC (rev
72385)
@@ -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 {
Modified: trunk/phase3/includes/filerepo/FileRepoStatus.php
===================================================================
--- trunk/phase3/includes/filerepo/FileRepoStatus.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/FileRepoStatus.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -1,4 +1,10 @@
<?php
+/**
+ * Generic operation result for FileRepo-related operations
+ *
+ * @file
+ * @ingroup FileRepo
+ */
/**
* Generic operation result class for FileRepo-related operations
Modified: trunk/phase3/includes/filerepo/ForeignAPIFile.php
===================================================================
--- trunk/phase3/includes/filerepo/ForeignAPIFile.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/ForeignAPIFile.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -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
*/
Modified: trunk/phase3/includes/filerepo/ForeignAPIRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/ForeignAPIRepo.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/ForeignAPIRepo.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -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
Modified: trunk/phase3/includes/filerepo/ForeignDBFile.php
===================================================================
--- trunk/phase3/includes/filerepo/ForeignDBFile.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/ForeignDBFile.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -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 {
Modified: trunk/phase3/includes/filerepo/ForeignDBRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/ForeignDBRepo.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/ForeignDBRepo.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -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 {
Modified: trunk/phase3/includes/filerepo/ForeignDBViaLBRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/ForeignDBViaLBRepo.php 2010-09-04
17:46:30 UTC (rev 72384)
+++ trunk/phase3/includes/filerepo/ForeignDBViaLBRepo.php 2010-09-04
18:13:18 UTC (rev 72385)
@@ -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 {
Modified: trunk/phase3/includes/filerepo/Image.php
===================================================================
--- trunk/phase3/includes/filerepo/Image.php 2010-09-04 17:46:30 UTC (rev
72384)
+++ trunk/phase3/includes/filerepo/Image.php 2010-09-04 18:13:18 UTC (rev
72385)
@@ -1,7 +1,13 @@
<?php
+/**
+ * Backward compatibility code for MW < 1.11
+ *
+ * @file
+ */
/**
* Backwards compatibility class
+ *
* @deprecated
* @ingroup FileRepo
*/
Modified: trunk/phase3/includes/filerepo/LocalFile.php
===================================================================
--- trunk/phase3/includes/filerepo/LocalFile.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/LocalFile.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -1,5 +1,9 @@
<?php
/**
+ * Local file in the wiki's own database
+ *
+ * @file
+ * @ingroup FileRepo
*/
/**
Modified: trunk/phase3/includes/filerepo/LocalRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/LocalRepo.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/LocalRepo.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -1,5 +1,13 @@
<?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.
* @ingroup FileRepo
Modified: trunk/phase3/includes/filerepo/NullRepo.php
===================================================================
--- trunk/phase3/includes/filerepo/NullRepo.php 2010-09-04 17:46:30 UTC (rev
72384)
+++ trunk/phase3/includes/filerepo/NullRepo.php 2010-09-04 18:13:18 UTC (rev
72385)
@@ -1,4 +1,10 @@
<?php
+/**
+ * File repository with no files.
+ *
+ * @file
+ * @ingroup FileRepo
+ */
/**
* File repository with no files, for performance testing
Modified: trunk/phase3/includes/filerepo/OldLocalFile.php
===================================================================
--- trunk/phase3/includes/filerepo/OldLocalFile.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/OldLocalFile.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -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
Modified: trunk/phase3/includes/filerepo/RepoGroup.php
===================================================================
--- trunk/phase3/includes/filerepo/RepoGroup.php 2010-09-04 17:46:30 UTC
(rev 72384)
+++ trunk/phase3/includes/filerepo/RepoGroup.php 2010-09-04 18:13:18 UTC
(rev 72385)
@@ -1,14 +1,19 @@
<?php
/**
- * @defgroup FileRepo FileRepo
+ * Prioritized list of file repositories
*
* @file
* @ingroup FileRepo
*/
/**
+ * @defgroup FileRepo FileRepo
+ */
+
+/**
+ * Prioritized list of file repositories
+ *
* @ingroup FileRepo
- * Prioritized list of file repositories
*/
class RepoGroup {
var $localRepo, $foreignRepos, $reposInitialised = false;
Modified: trunk/phase3/includes/filerepo/UnregisteredLocalFile.php
===================================================================
--- trunk/phase3/includes/filerepo/UnregisteredLocalFile.php 2010-09-04
17:46:30 UTC (rev 72384)
+++ trunk/phase3/includes/filerepo/UnregisteredLocalFile.php 2010-09-04
18:13:18 UTC (rev 72385)
@@ -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
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
