Re: API documentation markup guides

From: Alan Cox (
Date: Wed Aug 02 2000 - 11:55:01 EST

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

No other tags. The idea is that you should be able to actually read those
comments non-intrusively in the source code and pull them out into
numerous document forms like man. <a href=""> wont work well in a man page

> 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.

Nobody has tackled that bit 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