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

Re: [RFC] Introducing svn_client_make_diff_args? (Was: RE: svn commit: r33116 - in branches/ignore-mergeinfo/subversion: include libsvn_client svn)

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Wed, 17 Sep 2008 17:53:50 +0100

Hyrum K. Wright wrote:
> Bert Huijben wrote:
[...]
> > Then on to the bikeshed:
> >
> > How should we call these structs, if we are going to use them as a new standard pattern?
> > (Once answered the result should probably be added to hacking.html before we release 1.6)
> >
> > Just some partial example:
> >
> > /** Argument container for @c svn_client_diff5
>
> "@c svn_client_diff5" -> "svn_client_diff5()"
> Doxygen will find the function if you postpend the parenthesis.

Yes.

> > *
> > * In order to avoid backwards compatibility problems clients should
> > * use @ svn_client_diff_args_create() to allocate and initialize this
> > * structure instead of doing so themselves.
> > *
> > * @since New in 1.6.
> > */
> > typedef struct svn_client_diff_args_t
> > {
> > /** Don't include any merge info in the diff output. Defaulting to
> > * false for backwards compatibility. */
>
> "Defaulting to false" -> "Defaults to @c FALSE"

Bikeshed. Several of our committers seem to prefer "@c FALSE". I much
prefer "false" because it's easier on the eyes, it's not a requirement
that the caller use this particular preprocessor macro, and it's not a
definition that we need to call attention to or that the reader needs to
follow a cross-reference to.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
For additional commands, e-mail: dev-help_at_subversion.tigris.org
Received on 2008-09-17 18:54:11 CEST

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