The third example from Krinkle looks like the only one being parsed
correctly :)
On Thu, Apr 26, 2012 at 4:16 PM, Ryan Kaldari <rkaldari(a)wikimedia.org>wrote;wrote:
On 4/26/12 12:59 PM, Krinkle wrote:
I'm not confinced (yet) that we should
migrate to "@param type $var:
description". Putting the type after the variable works just fine and
we've been
doing it for years, and in at least one case (the second one in the above
summary) the Doxygen parser actually chokes on it for whatever reason.
We definitely shouldn't migrate to "@param type $var: description" because
that's not valid doxygen syntax. The correct syntax is without a colon.
This is why your 2nd example ends up with mangled output. If we follow the
correct syntax, it should output fine. And since we're using the standard
doxygen parser, the only argument I can see for sticking with the old
syntax is because "we've been doing it for years", which isn't very
convincing.
Ryan Kaldari
______________________________**_________________
Wikitech-l mailing list
Wikitech-l(a)lists.wikimedia.org
https://lists.wikimedia.org/**mailman/listinfo/wikitech-l<https://lists.…
--
Jeremy Postlethwaite
jpostlethwaite(a)wikimedia.org
415-839-6885 x6790
Backend Software Developer
Wikimedia Foundation <http://wikimediafoundation.org/>