Re: 1.9 API review

On Thu, Mar 5, 2015 at 3:23 PM, Julian Foad <julianfoad_at_btopenworld.com>
wrote:

> Stefan Fuhrmann wrote:
> >I'm currently reviewing svn_fs.h and svn_repos.h.
> [...]
> > * Function references (e.g. in @see) should not
> > have "()" attached to them - just to be consistent
> > with what we do in most other places.
>
> I have adopted the practice of identifying functions with () in Doxygen
> doc strings because Doxygen recognizes that syntax and it's much neater
> than prefixing with '@c' or anything else. Inside '@see' Doxygen seems to
> assume (I'm only guessing) that every word is an identifier if it can find
> it, so the parentheses may be redundant in that particular context, but
> elsewhere they are valuable.
>

Ah, ok. I mostly noticed it in @see sections anyway,
so I'll only change it there.

-- Stefan^2.
Received on 2015-03-05 15:29:49 CET