r110503 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r110502‎ | r110503 | r110504 >
Date:17:05, 1 February 2012
Author:hashar
Status:ok
Tags:core 
Comment:
fix @example in ResourceLoaderFileModule

Doxygen @example is meant to include another file content. To render
an example you need to use a named paragraph and then a block of code.
Modified paths:
  • /trunk/phase3/includes/resourceloader/ResourceLoaderFileModule.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/resourceloader/ResourceLoaderFileModule.php
@@ -33,47 +33,74 @@
3434 protected $remoteBasePath = '';
3535 /**
3636 * 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
3841 */
3942 protected $scripts = array();
4043 /**
4144 * 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
4349 */
4450 protected $languageScripts = array();
4551 /**
4652 * 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
4857 */
4958 protected $skinScripts = array();
5059 /**
5160 * 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
5365 */
5466 protected $debugScripts = array();
5567 /**
5668 * 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
5873 */
5974 protected $loaderScripts = array();
6075 /**
6176 * 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
6381 */
6482 protected $styles = array();
6583 /**
6684 * 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
6889 */
6990 protected $skinStyles = array();
7091 /**
7192 * 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
7397 */
7498 protected $dependencies = array();
7599 /**
76100 * 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
78105 */
79106 protected $messages = array();
80107 /** String: Name of group to load this module in */
@@ -84,12 +111,18 @@
85112 protected $debugRaw = true;
86113 /**
87114 * Array: Cache for mtime
88 - * @example array( [hash] => [mtime], [hash] => [mtime], ... )
 115+ * @par Usage:
 116+ * @code
 117+ * array( [hash] => [mtime], [hash] => [mtime], ... )
 118+ * @endcode
89119 */
90120 protected $modifiedTime = array();
91121 /**
92122 * 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
94127 */
95128 protected $localFileRefs = array();
96129
@@ -106,6 +139,7 @@
107140 * to $wgScriptPath
108141 *
109142 * Below is a description for the $options array:
 143+ * @par Construction options:
110144 * @code
111145 * array(
112146 * // Base path to prepend to all local paths in $options. Defaults to $IP

Status & tagging log