Messages in this thread | | | Date | Wed, 2 Aug 2000 18:32:14 +0200 | From | Tim Waugh <> | Subject | Re: API documentation markup guides |
| |
On Wed, Aug 02, 2000 at 09:22:05AM -0700, breed@almaden.ibm.com 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.
Tim. */ [unhandled content-type:application/pgp-signature] | |