jenkins-bot has submitted this change and it was merged.
Change subject: doxygen: Document problem with slashes and fix a few
......................................................................
doxygen: Document problem with slashes and fix a few
Change-Id: I39f8f394e7421fca71e7d26818f7118e85de7e4f
---
M includes/resourceloader/ResourceLoader.php
M maintenance/mwdoc-filter.php
2 files changed, 26 insertions(+), 6 deletions(-)
Approvals:
Catrope: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/resourceloader/ResourceLoader.php
b/includes/resourceloader/ResourceLoader.php
index 4f1414b..57deb00 100644
--- a/includes/resourceloader/ResourceLoader.php
+++ b/includes/resourceloader/ResourceLoader.php
@@ -35,22 +35,32 @@
/** @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 8650689..0cc7bde 100644
--- a/maintenance/mwdoc-filter.php
+++ b/maintenance/mwdoc-filter.php
@@ -23,7 +23,17 @@
. '([^\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+'
--
To view, visit https://gerrit.wikimedia.org/r/157353
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I39f8f394e7421fca71e7d26818f7118e85de7e4f
Gerrit-PatchSet: 4
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Krinkle <[email protected]>
Gerrit-Reviewer: Addshore <[email protected]>
Gerrit-Reviewer: Catrope <[email protected]>
Gerrit-Reviewer: Hashar <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: Parent5446 <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits