[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: Justin Erenkrantz <jerenkrantz_at_apache.org>
Date: 2002-12-29 18:46:28 CET

--On Sunday, December 29, 2002 10:26 AM -0600 Karl Fogel
<kfogel@newton.ch.collab.net> wrote:

> 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.

If you don't use the @param tag, you have no way of indicating that
is the parameter. The only thing is that it is emphasized in the
brief description. I think that's a bit too subtle. But, I won't
belabor the point too much though.

As you can see in my commit to the branch, you can do both approaches
in the same comment. =) -- justin

---------------------------------------------------------------------
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:47:15 2002

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

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.