Document ResourceLoaderWikiModule::getPages.
authorMatthew Flaschen <mflaschen@wikimedia.org>
Tue, 18 Dec 2012 08:31:59 +0000 (03:31 -0500)
committerMatthew Flaschen <mflaschen@wikimedia.org>
Tue, 18 Dec 2012 08:34:45 +0000 (03:34 -0500)
Change-Id: Id3b3df20efcec90dfcc7cd496aecbe74e5cd9915

includes/resourceloader/ResourceLoaderWikiModule.php

index 1e61a3e..b85da16 100644 (file)
@@ -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 );