[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: Garrett Rooney <rooneg_at_electricjellyfish.net>
Date: 2002-12-29 15:26:08 CET

On Sunday, December 29, 2002, at 01:51 AM, Justin Erenkrantz wrote:

> --On Saturday, December 28, 2002 8:21 PM -0500 Garrett Rooney
> <rooneg@electricjellyfish.net> wrote:
>
>> hey, i spent an annoyingly long amount of time putting the comments
>> in that file into doxygen format and now you've gone and cluttered
>> it up again.
>>
>> just a friendly reminder to doxygenate it before you merge it into
>> /trunk.
>
> Sure - no problem. Out of curiousity, why do we not use @param's?
> Shouldn't we be using them? See APR's use of doxygen for an idea of
> what I'm getting at. -- justin

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?

so yeah, i guess my answer is "ask branko why he didn't use them" ;-)

-garrett

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Dec 29 15:26:53 2002

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