[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: rev 4200 - in branches/issue-951-dev/subversion: include libsvn_wc clients/cmdline tests/clients/cmdline/getopt_tests_data

From: Karl Fogel <kfogel_at_newton.ch.collab.net>
Date: 2002-12-29 17:26:47 CET

Garrett Rooney <rooneg@electricjellyfish.net> writes:
> i think we were avoiding them because when branko was coming up with
> the doxygen config we would use he was trying to stick as closely to
> the existing style as possible. personally, i think that in most
> cases, the existing comments have explanations for all the params, so
> having extra doxygen markup for them is just cluttering up the
> headers. unless having those tags allows doxygen to generate better
> output for some reason?

It's just that we have had a stylistic convention of introducing
parameters in the prose. Personally, I like this way, because it
often makes it easier to see how the paramaters relate to each other
and to the overall purpose of the function. Capitalizing them was
just a way of making them stand out as parameters; the doxygenation is
just to make them stand out in a markup-y way instead.

-K, who can read @param-style docs but is not a fan :-)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Dec 29 18:09:31 2002

This is an archived mail posted to the Subversion Dev mailing list.