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_Documentation

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.

-- 
Jeremy Postlethwaite
[email protected]
415-839-6885 x6790
Backend Software Developer
Wikimedia Foundation <http://wikimediafoundation.org/>
_______________________________________________
Wikitech-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Reply via email to