Using upper case means you're talking about that specific constant.
Not that some question is simply "true", but that we're talking about
the value TRUE.
Adding @c in there seems a bit much, so a simple uppercase TRUE can
tell the reader you're talking about the constant, not the
truth-quality.
Cheers,
-g
On Wed, Nov 5, 2008 at 4:31 AM, Julian Foad <julianfoad_at_btopenworld.com> wrote:
> On Wed, 2008-11-05 at 05:23 +0100, Neels J. Hofmeyr wrote:
>> > I've updated the doc strings in r34026/r34028/r34029.
>>
>> Thanks! I'd like to change one to say TRUE and FALSE in upper case, because
>> that's what is used with svn_boolean_t. Is it standard practice in the doc
>> strings to write true and false in lower case?
>
> We haven't standardized. I prefer lower case because I don't see a need
> to make them stand out visually, the reader doesn't need to follow a
> cross-reference to their definitions, and the API user doesn't need to
> use the same defined constants that we use internally. However, the
> majority of us seem to prefer upper case, usually with an "@c" Doxygen
> tag. I like consistency but ... whatever!
>
> - Julian
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
> For additional commands, e-mail: dev-help_at_subversion.tigris.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
For additional commands, e-mail: dev-help_at_subversion.tigris.org
Received on 2008-11-06 06:03:57 CET