r83109 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r83108‎ | r83109 | r83110 >
Date:20:28, 2 March 2011
Author:hashar
Status:ok (Comments)
Tags:
Comment:
doxygen can use @code !
Modified paths:
  • /trunk/phase3/includes/resourceloader/ResourceLoaderFileModule.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/resourceloader/ResourceLoaderFileModule.php
@@ -102,8 +102,9 @@
103103 * to $IP
104104 * @param $remoteBasePath String: Base path to prepend to all remote paths in $options. Defaults
105105 * to $wgScriptPath
106 - *
107 - * @example $options
 106+ *
 107+ * Below is a description for the $options array:
 108+ * @code
108109 * array(
109110 * // Base path to prepend to all local paths in $options. Defaults to $IP
110111 * 'localBasePath' => [base path],
@@ -138,6 +139,7 @@
139140 * // Group which this module should be loaded together with
140141 * 'group' => [group name string],
141142 * )
 143+ * @endcode
142144 */
143145 public function __construct( $options = array(), $localBasePath = null,
144146 $remoteBasePath = null )

Follow-up revisions

RevisionCommit summaryAuthorDate
r84991SocialProfile: use @code and @endcode for extra doc prettiness, as per r83109...ashley23:30, 29 March 2011

Comments

#Comment by Hashar (talk | contribs)   13:26, 7 March 2011

To review the rendering, look for the __construct method on the doxygen documentation site:

http://svn.wikimedia.org/doc/classResourceLoaderFileModule.html

Status & tagging log