ResourceLoaderImageModule: Fix incorrect documentation
authorRoan Kattouw <roan.kattouw@gmail.com>
Wed, 17 Jun 2015 02:33:59 +0000 (19:33 -0700)
committerRoan Kattouw <roan.kattouw@gmail.com>
Wed, 17 Jun 2015 02:37:39 +0000 (19:37 -0700)
The docs claimed that you had to do something like
'images' => array( 'filename.svg' => array( 'name' => 'foo' ) )
but what you actually need to do is
'images' => array( 'foo' => array( 'file' => 'filename.svg' ) )

Change-Id: Idca2d5c58e4d9fcf008ef5cfe7f8ce77b996c203

includes/resourceloader/ResourceLoaderImageModule.php

index 2caca87..ccdb88f 100644 (file)
@@ -86,9 +86,11 @@ class ResourceLoaderImageModule extends ResourceLoaderModule {
         *         // List of image files and their options
         *         'images' => array(
         *             [theme name] => array(
-        *                 [file path string],
-        *                 [file path string] => array(
-        *                     'name' => [image name string, defaults to file name],
+        *                 [icon name] => array(
+        *                     'file' => [file path string or array whose values are file path strings
+        *                                    and whose keys are 'default', 'ltr', 'rtl', a single
+        *                                    language code like 'en', or a list of language codes like
+        *                                    'en,de,ar'],
         *                     'variants' => [array of variant name strings, variants
         *                                    available for this image],
         *                 ),