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

Re: svn commit: r27752 - trunk/subversion/include

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2007-11-15 20:28:32 CET

Erik Huelsmann wrote:
> On Nov 9, 2007 11:05 PM, <hwright@tigris.org> wrote:
>
>>Author: hwright
>>Date: Fri Nov 9 14:05:27 2007
>>New Revision: 27752
>>
>>Log:
>>Doxygen cleanup.
>>
>>* subversion/include/*.h:
>> Convert false, true, and null to FALSE, TRUE and NULL.
>
>
> If you do that, wouldn't it be a good idea to precede them with @c to
> make them formatted as constants by doxygen?

Please no.

   * The words "true", "false" and "null" have the right meanings already. The
defined constants that we use in our C code to represent these three meanings
are an implementation detail. A user calling our API doesn't even have to use
the same defined constants that we do.

   * These values are so common and standard that formatting every mention in
such a way as to remind the reader that it's a defined constant, and (depending
on the documentation viewer software) providing a link to the definition, would
only be a distraction from readability. In the plain text especially, "non-@c
NULL" is really ugly to read.

Consistency is good. I'd much prefer lower case. Definitely don't go adding
"@c" to them.

Thanks.
- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Nov 15 20:28:47 2007

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