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

Re: API documentation wanted (for Python in particular)

From: Daniel Berlin <dberlin_at_dberlin.org>
Date: 2006-03-13 15:50:30 CET

On Mon, 2006-03-13 at 09:31 -0500, Paul Koning wrote:
> >>>>> "Daniel" == Daniel Berlin <dberlin@dberlin.org> writes:
>
> >> Personally, I don't find that "read the source" is reasonable
> >> documentation, but I guess opinions differ. And I suppose SWIG is
> >> a mechanical transformation.
>
> Daniel> Okay, well, you can always use the doxygen generated docs if
> Daniel> you like.
>
> Daniel> That is how gcc, for example, documents libstdc++.
>
> Daniel> It's pretty standard in projects i've seen to keep API
> Daniel> documentation in the code, or have it generated from the
> Daniel> comments. Anything else gets out of date *very* quickly, and
> Daniel> becomes worse than useless.
>
> I'd offer gccint as a counterexample. I suppose it's a fairly rare
> one; other *int manuals tend to be marginal at best.

gccint is horribly out of date, actually, and getting moreso all the
time.

It is also useless to anyone actually attempting to do anything but
write a port (IE write a new pass, etc).

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Mon Mar 13 16:01:28 2006

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