netdev
[Top] [All Lists]

Re: good API example docs on-line

To: Richard Guy Briggs <rgb@xxxxxxxxxxxxxxxxxxxxx>
Subject: Re: good API example docs on-line
From: Andi Kleen <ak@xxxxxx>
Date: Thu, 10 May 2001 13:38:25 +0200
Cc: Linux Ipsec mailing list <linux-ipsec@xxxxxxxxxxxx>, netdev@xxxxxxxxxxx
In-reply-to: <20010510030012.A1421@aaitlol.conscoop.ottawa.on.ca>; from Richard Guy Briggs on Thu, May 10, 2001 at 09:00:12AM +0200
References: <20010510030012.A1421@aaitlol.conscoop.ottawa.on.ca>
Sender: owner-netdev@xxxxxxxxxxx
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/*

-Andi

<Prev in Thread] Current Thread [Next in Thread>