Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 3 Jan 2003 19:52:09 +0000
From:      Tony Finch <dot@dotat.at>
To:        Peter Wemm <peter@wemm.org>
Cc:        "Alan L. Cox" <alc@imimic.com>, John Baldwin <jhb@FreeBSD.org>, Nate Lawson <nate@root.org>, cvs-committers@freebsd.org, cvs-all@freebsd.org, Alan Cox <alc@FreeBSD.org>
Subject:   Re: cvs commit: src/sys/nfsclient nfs_vnops.c
Message-ID:  <20030103195209.A15025@chiark.greenend.org.uk>
In-Reply-To: <20030103192950.0FC392A7EA@canning.wemm.org>; from peter@wemm.org on Fri, Jan 03, 2003 at 11:29:50AM -0800
References:  <3E14985A.35AB67F4@imimic.com> <20030103192950.0FC392A7EA@canning.wemm.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Fri, Jan 03, 2003 at 11:29:50AM -0800, Peter Wemm wrote:
> 
> One thing that I miss from my (ancient?) Amiga days is Autodoc.  It was a
> formalized way of having docs embedded with the code and having them mined
> with a tool and collected into coherent man-page-like docs.

I've tried to use Doxygen for this. It produces HTML rather than man
pages, but the documentation format is quite nice (similar to JavaDoc)
and the output looks good too. However it has terrible trouble with
typical C -- the author is a C++ programmer and Doxygen assumes the code
is structured OOly rather than modularly -- and it's really hard to fix
the broken assumptions so that it works properly.

Tony.
-- 
f.a.n.finch  <dot@dotat.at>  http://dotat.at/
BISCAY: SOUTHWESTERLY 6 TO GALE 8, OCCASIONALLY SEVERE GALE 9 IN SOUTH AT
FIRST, DECREASING NORTHERLY 3 OR 4. THUNDERY SHOWERS. MODERATE OR GOOD.

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030103195209.A15025>