Re: inline API documentation formats (was: devfs - why not ?)

Matthias Andree (ma@dt.e-technik.uni-dortmund.de)
13 Apr 2000 12:27:06 +0200

Alan Cox <alan@lxorguk.ukuu.org.uk> writes:

> > > the kernel manual semi-automatically
> >
> > I've been meaning to look at that. It depends on:
> >
> > - how ugly I find the gdoc/javadoc format :-)
>
> See drivers/net/z85230.c for an example. It is meant to drop into comments
> in such a way that its hardly obvious they are 'special' in any way.
>
> > - whether man pages and HTML can be automatically generated.
>
> It'll output man pages, html, tex, pdf, ps, dvi and probably a few more
> formats. It turns the pages into DocBook SGML (an SGML markup originally
> aimed at technical documentation), from there the tools can make almost
> anything of it easily (except ascii, although there are ugly ways to do
> that job)

How does that format and output compare to Doxygen?

http://www.stack.nl/~dimitry/doxygen/

-- 
Matthias Andree


                Where do you think you're going today?


-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.rutgers.edu
Please read the FAQ at http://www.tux.org/lkml/