From: Aaron Schulz <aaron@users.mediawiki.org>
Date: Thu, 29 Sep 2011 21:17:43 +0000 (+0000)
Subject: FU r98405: various document cleanup
X-Git-Tag: 1.31.0-rc.0~27361
X-Git-Url: https://git.cyclocoop.org/%27.%24link.%27?a=commitdiff_plain;h=6559b8bf;p=lhc%2Fweb%2Fwiklou.git

FU r98405: various document cleanup
---

diff --git a/includes/cache/FileCacheBase.php b/includes/cache/FileCacheBase.php
index 4c5d41e381..3a51af4abe 100644
--- 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 a60d5d27d3..d39514ae9c 100644
--- 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 d4f98e22d1..5503226931 100644
--- 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
 	 */