On 27 April 2012 02:16, Ryan Kaldari <rkaldari(a)wikimedia.org> wrote:
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.
This gives me headache:
@param $title Title Title for the method
There is no separation between the type and description, which makes
it hard to read and want to use the type as part of the description
So +1 for:
@param Title $title Title for the method.
-Niklas