Hashar has uploaded a new change for review.
Change subject: (bug 38492) make variables documented
......................................................................
(bug 38492) make variables documented
We are using '@var' to document our variables and class properties,
which is unfortunately not working since '@var' is really meant to
document a function or method.
The way to fix it is to use an input filter that will rewrite our PHP
source code to pretends variables are typed. Aka something like:
/**
* A title object
* @var Title
*/
var $title;
Will be made:
/**
* A title object
* @var Title
*/
Title $title;
That is incorrect PHP code but it is properly recognized by Doxygen.
This patch as a side effect, all variables and properties will end up
being documented in addition of type hinting.
Use a hack authored by Goran Rakic at:
http://stackoverflow.com/a/8472180/276152
Change-Id: I4ead1bd1feace44496b45ed8c55f5e52c59e7694
---
M maintenance/Doxyfile
A maintenance/mwdoc-filter.php
2 files changed, 14 insertions(+), 1 deletion(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/92/17192/1
--
To view, visit https://gerrit.wikimedia.org/r/17192
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I4ead1bd1feace44496b45ed8c55f5e52c59e7694
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Hashar <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
