FU r98405: various document cleanup

diff --git a/includes/cache/FileCacheBase.php b/includes/cache/FileCacheBase.php
index 4c5d41e..3a51af4 100644 (file)
--- a/includes/cache/FileCacheBase.php
+++ b/includes/cache/FileCacheBase.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Contain the HTMLFileCache class
+ * Contain the FileCacheBase class
  * @file
  * @ingroup Cache
  */
@@ -128,7 +128,7 @@ abstract class FileCacheBase {
                return $text;
        }
 
-       /*
+       /**
         * Clear the cache for this page
         * @return void
         */
@@ -138,7 +138,7 @@ abstract class FileCacheBase {
                wfRestoreWarnings();
        }
 
-       /*
+       /**
         * Create parent directors of $this->cachePath()
         * @TODO: why call wfMkdirParents() twice?
         * @return void
@@ -152,7 +152,7 @@ abstract class FileCacheBase {
                wfMkdirParents( $mydir2, null, __METHOD__ );
        }
 
-       /*
+       /**
         * Return relative multi-level hash subdirectory with the trailing
         * slash or the empty string if $wgFileCacheDepth is off
         * @return string

diff --git a/includes/cache/HTMLFileCache.php b/includes/cache/HTMLFileCache.php
index a60d5d2..d39514a 100644 (file)
--- a/includes/cache/HTMLFileCache.php
+++ b/includes/cache/HTMLFileCache.php
@@ -5,7 +5,12 @@
  * @ingroup Cache
  */
 class HTMLFileCache extends FileCacheBase {
-
+       /**
+        * Construct an ObjectFileCache from a Title and an action
+        * @param $title Title
+        * @param $action string
+        * @return HTMLFileCache
+        */
        public static function newFromTitle( Title $title, $action ) {
                $cache = new self();
 
@@ -20,7 +25,7 @@ class HTMLFileCache extends FileCacheBase {
                return $cache;
        }
 
-       /*
+       /**
         * Cacheable actions
         * @return array
         */

diff --git a/includes/cache/ObjectFileCache.php b/includes/cache/ObjectFileCache.php
index d4f98e2..5503226 100644 (file)
--- a/includes/cache/ObjectFileCache.php
+++ b/includes/cache/ObjectFileCache.php
@@ -1,6 +1,16 @@
 <?php
+/**
+ * Contain the ObjectFileCache class
+ * @file
+ * @ingroup Cache
+ */
 class ObjectFileCache extends FileCacheBase {
-
+       /**
+        * Construct an ObjectFileCache from a key and a type
+        * @param $key string
+        * @param $type string
+        * @return ObjectFileCache
+        */
        public static function newFromKey( $key, $type ) {
                $cache = new self();
 
@@ -15,7 +25,7 @@ class ObjectFileCache extends FileCacheBase {
                return $cache;
        }
 
-       /*
+       /**
         * Get the type => extension mapping
         * @return array
         */