cURL / Mailing Lists / curl-library / Single Mail


documenting internals (was Re: SSL and basic authentication.)

From: Daniel Stenberg <>
Date: Sun, 2 Nov 2008 23:54:30 +0100 (CET)

On Sat, 1 Nov 2008, Dan Fandrich wrote:

> How about converting the function and structure comments into Doxygen format
> (which is similar to JavaDoc)? Doxygen can do a pretty nice job of creating
> pretty documentation from comments in the source without greatly affecting
> its readability.

I wouldn't mind that as it is a fairly un-intrusive format, but I must confess
that I have yet to see some nice and handy output from doxygen. In my view,
its output still leaves out a lot - actually to the extent that I think
manually writing a document/description of how things are tied together often
is more readable and human parseable.

But maybe I've just had bad experiences...

Received on 2008-11-03