[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: Branko Čibej <brane_at_xbc.nu>
Date: 2002-12-04 02:03:27 CET

Karl Fogel wrote:

>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?
>
Ah, but you see, Doxygen is extremely flexible and you can make the
markup practically invisible.

>(On the other, Doxygen might be easier if we continue to put the param
>names in all-caps.)
>
Blech. That all-caps stuff is yuck anyway. :-)
Would you accept appropriate font-lock highlighting for the Doxygen markup?

The point is, though, that Doxygen generates superb html docs, and this
is something we'll need before 1.0.

-- 
Brane Čibej   <brane_at_xbc.nu>   http://www.xbc.nu/brane/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Dec 4 02:04:07 2002

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