Re: API documentation markup guides

From: Tim Waugh (
Date: Wed Aug 02 2000 - 11:32:14 EST

On Wed, Aug 02, 2000 at 09:22:05AM -0700, wrote:

> found a bit of blurbage in the kernel-doc script. However, it is unclear
> what other tags are recommended for formatting (<b> and <pre> for example).

No other tags. That markup is translated into all sorts of others:
text, man, DocBook, and from there to PostScript, PDF, whatever. The
only valid mark-up tags are the ones listed in the comment at the top
of kernel-doc.

> Is there a web page or doc that would serve as a quick reference?
> (kernel-doc-nano is a bit too quick...)

Not really. I should slow kernel-doc-nano-HOWTO down a bit I guess.

> I'm also a bit at a loss on how to document structures in header
> files. All the uses (granted my search has not be exhaustive) seem
> to be for functions.

I don't think this can be done properly yet.


To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to
Please read the FAQ at

This archive was generated by hypermail 2b29 : Mon Aug 07 2000 - 21:00:08 EST