[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: C. Michael Pilato <cmpilato_at_collab.net>
Date: 2006-05-10 14:48:45 CEST

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

-- 
C. Michael Pilato <cmpilato@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

Received on Wed May 10 14:49:27 2006

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