From: aude <aude.wiki@gmail.com>
Date: Tue, 2 Dec 2014 22:50:58 +0000 (-0500)
Subject: Add documentation for SiteListFileCache
X-Git-Tag: 1.31.0-rc.0~12908
X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=8f18fbee583024c734612052c8e65e0a5849f8d8;p=lhc%2Fweb%2Fwiklou.git

Add documentation for SiteListFileCache

Change-Id: I6c5b7fdfbbd6a4e6d67bd0f4aff539ce4d97cfda
---

diff --git a/includes/site/SiteListFileCache.php b/includes/site/SiteListFileCache.php
index f2a95a828e..e48a187a8d 100644
--- a/includes/site/SiteListFileCache.php
+++ b/includes/site/SiteListFileCache.php
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -16,12 +15,19 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
- * @since 1.25
- *
  * @file
  *
  * @license GNU GPL v2+
  */
+
+/**
+ * Provides a file-based cache of a SiteStore, stored as a json file.
+ * The cache can be built with the rebuildSitesCache.php maintenance script,
+ * and a MediaWiki instance can be setup to use this by setting the
+ * 'wgSitesCacheFile' configuration to the cache file location.
+ *
+ * @since 1.25
+ */
 class SiteListFileCache {
 
 	/**
@@ -55,7 +61,11 @@ class SiteListFileCache {
 	}
 
 	/**
+	 * @param string $globalId
+	 *
 	 * @since 1.25
+	 *
+	 * @return Site|null
 	 */
 	public function getSite( $globalId ) {
 		$sites = $this->getSites();