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

Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf

From: Max Bowsher <maxb1_at_ukf.net>
Date: 2006-04-20 11:08:03 CEST

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Justin Erenkrantz wrote:
> On 4/16/06, Peter N. Lundblad <peter@famlundblad.se> wrote:
>> No doxygen for internal code. There, we use the GNU style.
>
> It seems like we're using doxygen in some other places internally.
> HACKING says that doxygen is preferred and that GNU style is for older
> doc styles - not just internal.

That sentence of hacking.html immediately follows one that specifically
talks about 'interface documentation' - i.e. it is specifically talking
about public interfaces only/

> I'd personally prefer doxygen (aka JavaDoc) over GNU style. We should
> be able to auto-generate our docs for internal interfaces too. We
> can't really do that with GNU style docco... -- justin

Why would we want autogenerated separate documentation for intralibrary
functions? Such documentation only needs to get read by people actually
looking at the code itself, so simply embedding it in the code and
optimizing for readability in a text editor seems a reasonable thing to
do to me.

Max.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.1 (Cygwin)

iD8DBQFER09zfFNSmcDyxYARAlhZAKC/JU8a2NvR1zwlFT09po6Mb5T59ACgmhnB
uos668oyl3TOzn+tOzeQbFw=
=d1iv
-----END PGP SIGNATURE-----

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Apr 20 11:09:01 2006

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

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.