From 8c34c8ed5e3f581b0d507aa7a4a90ac776aa9a87 Mon Sep 17 00:00:00 2001
From: Timo Tijhof <krinklemail@gmail.com>
Date: Sat, 30 Aug 2014 18:51:42 +0200
Subject: [PATCH] doxygen: Document problem with slashes and fix a few

Change-Id: I39f8f394e7421fca71e7d26818f7118e85de7e4f
---
 includes/resourceloader/ResourceLoader.php | 20 +++++++++++++++-----
 maintenance/mwdoc-filter.php               | 12 +++++++++++-
 2 files changed, 26 insertions(+), 6 deletions(-)

diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php
index 4f1414bc5e..57deb00d21 100644
--- a/includes/resourceloader/ResourceLoader.php
+++ b/includes/resourceloader/ResourceLoader.php
@@ -35,22 +35,32 @@ class ResourceLoader {
 	/** @var bool */
 	protected static $debugMode = null;
 
-	/** @var array Module name/ResourceLoaderModule object pairs */
+	/**
+	 * Module name/ResourceLoaderModule object pairs
+	 * @var array
+	 */
 	protected $modules = array();
 
-	/** @var array Associative array mapping module name to info associative array */
+	/**
+	 * Associative array mapping module name to info associative array
+	 * @var array
+	 */
 	protected $moduleInfos = array();
 
 	/** @var Config $config */
 	private $config;
 
 	/**
-	 * @var array Associative array mapping framework ids to a list of names of test suite modules
-	 *      like array( 'qunit' => array( 'mediawiki.tests.qunit.suites', 'ext.foo.tests', .. ), .. )
+	 * Associative array mapping framework ids to a list of names of test suite modules
+	 * like array( 'qunit' => array( 'mediawiki.tests.qunit.suites', 'ext.foo.tests', .. ), .. )
+	 * @var array
 	 */
 	protected $testModuleNames = array();
 
-	/** @var array E.g. array( 'source-id' => 'http://.../load.php' ) */
+	/**
+	 * E.g. array( 'source-id' => 'http://.../load.php' )
+	 * @var array
+	 */
 	protected $sources = array();
 
 	/** @var bool */
diff --git a/maintenance/mwdoc-filter.php b/maintenance/mwdoc-filter.php
index 8650689160..0cc7bde8a4 100644
--- a/maintenance/mwdoc-filter.php
+++ b/maintenance/mwdoc-filter.php
@@ -23,7 +23,17 @@ $regexp = '#'
 	. '([^\s]+)'
 	. '\s+'
 	// Any text or line(s) between type hint and '/' closing the comment
-	// (includes the star of "*/")
+	// (includes the star of "*/"). Descriptions containing a slash
+	// are not supported. Those will have to to be rewritten to have their
+	// description *before* the @var:
+	// /**
+	//  * Description with / in it.
+	//  * @var array
+	//  */
+	// instead of:
+	// /**
+	//  * @var array Description with / in it.
+	//  */
 	. '([^/]+)'
 	. '/'
 	. '\s+'
-- 
2.20.1