On Thu, May 10, 2001 at 01:38:25PM +0200, Andi Kleen wrote:
> On Thu, May 10, 2001 at 09:00:12AM +0200, Richard Guy Briggs wrote:
> > Hi all,
> > I'm looking for good API example docs.
> > I'm struggling with the KLIPS2 design doc set and in particular, am
> > having trouble nailing down the various bits of API to make the design
> > concise, clear and complete. It would have the entities being
> > connected or interface name, a function call name, all parameters used,
> > a description of each parameter, a description of the function, what
> > globals affect its behaviour and its return values.
> > Can anyone think of any decent on-line API documents that are clear,
> > consise and complete for any project?
> You could e.g. use the existing kernel infrastructure for function
> documentation. See Documentation/DocBook/*
Thanks, there were several good examples. It would be good to convert
all this doc to DocBook that could be used/included in a similar way.
Mike Shaver pointed me at the OpenGL spec as an example... whew, it is
slainte mhath, RGB
Richard Guy Briggs -- PGP key available Auto-Free Ottawa! Canada
Prevent Internet Wiretapping! -- FreeS/WAN:<www.freeswan.org>
Thanks for voting Green! -- <green.ca> Marillion:<www.marillion.co.uk>