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

Re: API documentation [was: Re: Problem with python swig example - geturl.py]

From: Karl Fogel <kfogel_at_newton.ch.collab.net>
Date: 2002-12-04 00:29:55 CET

Branko Čibej <brane@xbc.nu> writes:
> +1! This is something I'd been thinking about on and off for a while.
> Our public APIs are moderately well documented, but looking into headers
> can be a bit of a pain sometimes. I say let's use Doxygen for all our
> source docs. Starting with just the public headers in subversion/include
> shouldn't be that hard.

Isn't Doxygen format the one used in APR?

Personally, I find that format much less readable in the sources.
Maybe it produces good printed docs and html, but the downside is
there's this markup all over the source files... And the source files
is what most developers read on a daily basis, no?

(On the other, Doxygen might be easier if we continue to put the param
names in all-caps.)

In any case, this should be a majority rules decision among the
developers. I'm not vetoing, just explaining my preference. I like
the status quo, YMMV :-).

-K

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Dec 4 01:07:55 2002

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