[bind10-dev] API documentation (was Re: DNS packet API: the name object)

[Jeremy C. Reed]

On Mon, 17 Aug 2009, JINMEI Tatuya / 神明達哉 wrote:

> I'd first like to know what kind of document in which level of detail
> we're expected to produce as documentation. This is a general
> question, but to be specific at the moment I'm currently most
> concerned with the document about the "message API".  For example, are
> we expected to provide a comprehensive API reference manual like the
> one for dnsyphtyon?
> http://www.dnspython.org/docs/1.7.1/html/

Yes for everything that an outside developer would use.

But rendered by default to not be on some many different webpages.

Also I like 
http://www.unbound.net/documentation/libunbound-tutorial-1.html
through
http://www.unbound.net/documentation/libunbound-tutorial-6.html
(which I believe someone else at ISC pointed out as useful documentation)
It is more readable and understandable as a "tutorial".

> If so, how we can make such a document?  I guess we'll use some
> conversion tool so that we can reuse the source code itself as much as
> possible and avoid duplicated work, but I don't know which tool we're
> going to use.  Do you have any idea or suggestion?

I will bring that up in following emails. (We had some past discussion on 
this ... I need to find my notes.)

> Or are we expected to write down source code description?  (If so, it
> would be a quite heavy task...)

Probably explanations of code itself is not needed except for decisions 
made if not clear. I will let others state their needs ...