Hello!
In the Mediawiki coding conventions section on PHP, the format for @param
tag is not what Doxygen recommends.
http://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Comments_and_Do…
We have:
General format for parameters is such: @param $varname [type]: [description].
Multiple types can be listed by separating with a pipe character.
I added a note in the document:
Doxygen documentation states that @param should have the same format as
phpDocumentor[1]<http://www.mediawiki.org/wiki/Manual:Coding_conventions…
:
@param datatype1|datatype2 $paramname description
How should we deal with this?
Thanks.
--
Jeremy Postlethwaite
jpostlethwaite(a)wikimedia.org
415-839-6885 x6790
Backend Software Developer
Wikimedia Foundation <http://wikimediafoundation.org/>