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

Re: [PATCH] Tweak doxygen markups in subversion/include/svn_client.h

From: Peter N. Lundblad <peter_at_famlundblad.se>
Date: 2006-05-10 15:42:07 CEST

C. Michael Pilato writes:
> Peter N. Lundblad wrote:
> > Madan U Sreenivasan writes:
> > >
> > > Hi,
> > >
> > > Pl. find attached a patch containing tweaks to doxygen
> > > markups. Kinda follow-up to r19589.
> > >
> > > [[[
> > > Tweak doxygen markups.
> > >
> > > * subversion/include/svn_client.h
> > > (svn_client_add3, svn_client_import2, svn_client_blame3,
> > > svn_client_blame2, svn_client_export3,
> > > svn_client_lock): Markup boolean values with @c.
> >
> > The problem with this is that it somewhat implies that the values must be
> > these particular values (which is nearly always not the case for true values).
> > I think we should go in the other direction, only talking about true
> > and false values in lowercase and without markup. So, "if @a b is
> > true..." implies not the exact value TRUE.
>
> If that's the case, then I'd suggest we use the terminology "set" and
> "unset" (instead of "true" and "false", which might be confused with the
> preprocessor definitions TRUE and FALSE).
>

Nah, I don't think that makes it clearer. Talking about "true values" and
"false values", however makes sense. I think it is clear that we
aren't talking about the "literals". But I can live with "@c TRUE and
"@c FALSE" as well, I just think it is a minro read/writability
issue.

/me paints his bikeshed in different colors...

//Peter

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed May 10 15:42:45 2006

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