Index: trunk/phase3/includes/resourceloader/ResourceLoaderFileModule.php |
— | — | @@ -33,47 +33,74 @@ |
34 | 34 | protected $remoteBasePath = ''; |
35 | 35 | /** |
36 | 36 | * Array: List of paths to JavaScript files to always include |
37 | | - * @example array( [file-path], [file-path], ... ) |
| 37 | + * @par Usage: |
| 38 | + * @code |
| 39 | + * array( [file-path], [file-path], ... ) |
| 40 | + * @endcode |
38 | 41 | */ |
39 | 42 | protected $scripts = array(); |
40 | 43 | /** |
41 | 44 | * Array: List of JavaScript files to include when using a specific language |
42 | | - * @example array( [language-code] => array( [file-path], [file-path], ... ), ... ) |
| 45 | + * @par Usage: |
| 46 | + * @code |
| 47 | + * array( [language-code] => array( [file-path], [file-path], ... ), ... ) |
| 48 | + * @endcode |
43 | 49 | */ |
44 | 50 | protected $languageScripts = array(); |
45 | 51 | /** |
46 | 52 | * Array: List of JavaScript files to include when using a specific skin |
47 | | - * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... ) |
| 53 | + * @par Usage: |
| 54 | + * @code |
| 55 | + * array( [skin-name] => array( [file-path], [file-path], ... ), ... ) |
| 56 | + * @endcode |
48 | 57 | */ |
49 | 58 | protected $skinScripts = array(); |
50 | 59 | /** |
51 | 60 | * Array: List of paths to JavaScript files to include in debug mode |
52 | | - * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... ) |
| 61 | + * @par Usage: |
| 62 | + * @code |
| 63 | + * array( [skin-name] => array( [file-path], [file-path], ... ), ... ) |
| 64 | + * @endcode |
53 | 65 | */ |
54 | 66 | protected $debugScripts = array(); |
55 | 67 | /** |
56 | 68 | * Array: List of paths to JavaScript files to include in the startup module |
57 | | - * @example array( [file-path], [file-path], ... ) |
| 69 | + * @par Usage: |
| 70 | + * @code |
| 71 | + * array( [file-path], [file-path], ... ) |
| 72 | + * @endcode |
58 | 73 | */ |
59 | 74 | protected $loaderScripts = array(); |
60 | 75 | /** |
61 | 76 | * Array: List of paths to CSS files to always include |
62 | | - * @example array( [file-path], [file-path], ... ) |
| 77 | + * @par Usage: |
| 78 | + * @code |
| 79 | + * array( [file-path], [file-path], ... ) |
| 80 | + * @endcode |
63 | 81 | */ |
64 | 82 | protected $styles = array(); |
65 | 83 | /** |
66 | 84 | * Array: List of paths to CSS files to include when using specific skins |
67 | | - * @example array( [file-path], [file-path], ... ) |
| 85 | + * @par Usage: |
| 86 | + * @code |
| 87 | + * array( [file-path], [file-path], ... ) |
| 88 | + * @endcode |
68 | 89 | */ |
69 | 90 | protected $skinStyles = array(); |
70 | 91 | /** |
71 | 92 | * Array: List of modules this module depends on |
72 | | - * @example array( [file-path], [file-path], ... ) |
| 93 | + * @par Usage: |
| 94 | + * @code |
| 95 | + * array( [file-path], [file-path], ... ) |
| 96 | + * @endcode |
73 | 97 | */ |
74 | 98 | protected $dependencies = array(); |
75 | 99 | /** |
76 | 100 | * Array: List of message keys used by this module |
77 | | - * @example array( [message-key], [message-key], ... ) |
| 101 | + * @par Usage: |
| 102 | + * @code |
| 103 | + * array( [message-key], [message-key], ... ) |
| 104 | + * @endcode |
78 | 105 | */ |
79 | 106 | protected $messages = array(); |
80 | 107 | /** String: Name of group to load this module in */ |
— | — | @@ -84,12 +111,18 @@ |
85 | 112 | protected $debugRaw = true; |
86 | 113 | /** |
87 | 114 | * Array: Cache for mtime |
88 | | - * @example array( [hash] => [mtime], [hash] => [mtime], ... ) |
| 115 | + * @par Usage: |
| 116 | + * @code |
| 117 | + * array( [hash] => [mtime], [hash] => [mtime], ... ) |
| 118 | + * @endcode |
89 | 119 | */ |
90 | 120 | protected $modifiedTime = array(); |
91 | 121 | /** |
92 | 122 | * Array: Place where readStyleFile() tracks file dependencies |
93 | | - * @example array( [file-path], [file-path], ... ) |
| 123 | + * @par Usage: |
| 124 | + * @code |
| 125 | + * array( [file-path], [file-path], ... ) |
| 126 | + * @endcode |
94 | 127 | */ |
95 | 128 | protected $localFileRefs = array(); |
96 | 129 | |
— | — | @@ -106,6 +139,7 @@ |
107 | 140 | * to $wgScriptPath |
108 | 141 | * |
109 | 142 | * Below is a description for the $options array: |
| 143 | + * @par Construction options: |
110 | 144 | * @code |
111 | 145 | * array( |
112 | 146 | * // Base path to prepend to all local paths in $options. Defaults to $IP |