DragonFly BSD
DragonFly kernel List (threaded) for 2003-10
[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]

Re: Documentation generation

From: "Matthew D. Fuller" <fullermd@xxxxxxxxxxxxxxx>
Date: Sun, 19 Oct 2003 10:22:59 -0500

On Sun, Oct 19, 2003 at 09:47:48AM +0100 I heard the voice of
Hiten Pandya, and lo! it spake thus:
> 	I would rather prefer documenting the necessary/important
> 	functions by hand in a DragonFly Kernel Handbook, which keeps
> 	things clean, and also allows detailed explanations.

Note that I'm slowly (every so slowly!) writing a mailbox access library.
However, one of the early things I did in it was writing a SGML
application for library documentation.  It's not, of course, as general
and rich as Docbook, but it IS aimed specifically at documenting data
structures and functions in a library.

You can see some samples of the output and a tarball of the source that
created it at <http://libpostal.sourceforge.net/docs/>.

Something along those lines might be useful; trying to do that specific a
kind of documentation in a general language like Docbook can be ugly.

Matthew Fuller     (MF4839)   |  fullermd@xxxxxxxxxxxxxxx
Systems/Network Administrator |  http://www.over-yonder.net/~fullermd/

"The only reason I'm burning my candle at both ends, is because I
      haven't figured out how to light the middle yet"

[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]