This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Using DocBook for a API documentation
- To: docbook at lists dot oasis-open dot org
- Subject: DOCBOOK: Using DocBook for a API documentation
- From: maarten de boer <maarten dot deboer at iua dot upf dot es>
- Date: Thu, 2 Dec 1999 16:19:41 +0100
- Cc: alsa-doc at alsa-project dot org
- Organization: IUA
- References: <38435EF0.B400A27B@flashcom.net>
- Reply-To: docbook at lists dot oasis-open dot org
Hi DocBook list,
We want to use DocBook for the documentation of
the ALSA library API, www.alsa-project.org.
It seems to me that DocBook provides some tags to
help this, like:
FuncDef , FuncParams , FuncPrototype , FuncSynopsis ,
FuncSynopsisInfo, FuncDefs.
What is not clear to me is how the overall structure
of such a documentation should be. What would be the
tags to:
* group function in certain categories
* follow every function by a descriptive paragraph
* have "See also:" references
* generate an index of all functions
Does anybody know of an API that has been documented like
this with DocBook ? Any suggestions ?
Regards,
Maarten