From: Matthew Flaschen <mflaschen@wikimedia.org>
Date: Tue, 18 Dec 2012 08:31:59 +0000 (-0500)
Subject: Document ResourceLoaderWikiModule::getPages.
X-Git-Tag: 1.31.0-rc.0~21269
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=8f0df557dcb58f5a434ad164dc2f01e671feb920;p=lhc%2Fweb%2Fwiklou.git

Document ResourceLoaderWikiModule::getPages.

Change-Id: Id3b3df20efcec90dfcc7cd496aecbe74e5cd9915
---

diff --git a/includes/resourceloader/ResourceLoaderWikiModule.php b/includes/resourceloader/ResourceLoaderWikiModule.php
index 1e61a3e846..b85da16f32 100644
--- a/includes/resourceloader/ResourceLoaderWikiModule.php
+++ b/includes/resourceloader/ResourceLoaderWikiModule.php
@@ -42,7 +42,20 @@ abstract class ResourceLoaderWikiModule extends ResourceLoaderModule {
 	/* Abstract Protected Methods */
 
 	/**
+	 * Subclasses should return an associative array of resources in the module.
+	 * Keys should be the title of a page in the MediaWiki or User namespace.
+	 *
+	 * Values should be a nested array of options.  The supported keys are 'type' and
+	 * (CSS only) 'media'.
+	 *
+	 * For scripts, 'type' should be 'script'.
+	 *
+	 * For stylesheets, 'type' should be 'style'.
+	 * There is an optional media key, the value of which can be the
+	 * medium ('screen', 'print', etc.) of the stylesheet.
+	 *
 	 * @param $context ResourceLoaderContext
+	 * @return array
 	 */
 	abstract protected function getPages( ResourceLoaderContext $context );