Add documentation for SiteListFileCache

Change-Id: I6c5b7fdfbbd6a4e6d67bd0f4aff539ce4d97cfda

diff --git a/includes/site/SiteListFileCache.php b/includes/site/SiteListFileCache.php
index f2a95a8..e48a187 100644 (file)
--- 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();