From f6d01d8bd3ad17f5357f246602018ad3ce50c440 Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@users.mediawiki.org>
Date: Wed, 1 Feb 2012 17:05:15 +0000
Subject: [PATCH] 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.
---
 .../ResourceLoaderFileModule.php              | 56 +++++++++++++++----
 1 file changed, 45 insertions(+), 11 deletions(-)

diff --git a/includes/resourceloader/ResourceLoaderFileModule.php b/includes/resourceloader/ResourceLoaderFileModule.php
index 00bec82559..3d657e1c8c 100644
--- a/includes/resourceloader/ResourceLoaderFileModule.php
+++ b/includes/resourceloader/ResourceLoaderFileModule.php
@@ -33,47 +33,74 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
 	protected $remoteBasePath = '';
 	/**
 	 * Array: List of paths to JavaScript files to always include
-	 * @example array( [file-path], [file-path], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [file-path], [file-path], ... )
+	 * @endcode
 	 */
 	protected $scripts = array();
 	/**
 	 * Array: List of JavaScript files to include when using a specific language
-	 * @example array( [language-code] => array( [file-path], [file-path], ... ), ... )
+	 * @par Usage:
+	 * @code
+	 * array( [language-code] => array( [file-path], [file-path], ... ), ... )
+	 * @endcode
 	 */
 	protected $languageScripts = array();
 	/**
 	 * Array: List of JavaScript files to include when using a specific skin
-	 * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... )
+	 * @par Usage:
+	 * @code
+	 * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
+	 * @endcode
 	 */
 	protected $skinScripts = array();
 	/**
 	 * Array: List of paths to JavaScript files to include in debug mode
-	 * @example array( [skin-name] => array( [file-path], [file-path], ... ), ... )
+	 * @par Usage:
+	 * @code
+	 * array( [skin-name] => array( [file-path], [file-path], ... ), ... )
+	 * @endcode
 	 */
 	protected $debugScripts = array();
 	/**
 	 * Array: List of paths to JavaScript files to include in the startup module
-	 * @example array( [file-path], [file-path], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [file-path], [file-path], ... )
+	 * @endcode
 	 */
 	protected $loaderScripts = array();
 	/**
 	 * Array: List of paths to CSS files to always include
-	 * @example array( [file-path], [file-path], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [file-path], [file-path], ... )
+	 * @endcode
 	 */
 	protected $styles = array();
 	/**
 	 * Array: List of paths to CSS files to include when using specific skins
-	 * @example array( [file-path], [file-path], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [file-path], [file-path], ... )
+	 * @endcode
 	 */
 	protected $skinStyles = array();
 	/**
 	 * Array: List of modules this module depends on
-	 * @example array( [file-path], [file-path], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [file-path], [file-path], ... )
+	 * @endcode
 	 */
 	protected $dependencies = array();
 	/**
 	 * Array: List of message keys used by this module
-	 * @example array( [message-key], [message-key], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [message-key], [message-key], ... )
+	 * @endcode
 	 */
 	protected $messages = array();
 	/** String: Name of group to load this module in */
@@ -84,12 +111,18 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
 	protected $debugRaw = true;
 	/**
 	 * Array: Cache for mtime
-	 * @example array( [hash] => [mtime], [hash] => [mtime], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [hash] => [mtime], [hash] => [mtime], ... )
+	 * @endcode
 	 */
 	protected $modifiedTime = array();
 	/**
 	 * Array: Place where readStyleFile() tracks file dependencies
-	 * @example array( [file-path], [file-path], ... )
+	 * @par Usage:
+	 * @code
+	 * array( [file-path], [file-path], ... )
+	 * @endcode
 	 */
 	protected $localFileRefs = array();
 
@@ -106,6 +139,7 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
 	 *     to $wgScriptPath
 	 *
 	 * Below is a description for the $options array:
+	 * @par Construction options:
 	 * @code
 	 * 	array(
 	 * 		// Base path to prepend to all local paths in $options. Defaults to $IP
-- 
2.20.1