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

Re: 1.9 API review

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Thu, 5 Mar 2015 14:23:37 +0000

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.

- Julian
Received on 2015-03-05 15:26:35 CET

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