Krinkle and I went back and forth on this one last year. Apparently, it's a bit of a bootstrapping problem since all of our comments are currently written the wrong way (due to an old bug in doxygen that has since been fixed), and thus our comment parser expects them to be in the wrong format. Krinkle can elaborate.
I would support moving to the correct syntax though, as we shouldn't keep using the wrong one forever. Plus new hires are going to use the up-to-date syntax anyway (until we train them not too).
Ryan Kaldari
On 4/25/12 3:52 PM, Jeremy Postlethwaite wrote:
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_Doc...
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/PHP#cite_note-0 :
@param datatype1|datatype2 $paramname description
How should we deal with this?
Thanks.