[bind10-dev] DNS packet API: the name object

[JINMEI Tatuya / 神明達哉]

At Mon, 17 Aug 2009 10:25:57 -0500 (CDT),
"Jeremy C. Reed" <jreed at isc.org> wrote:

> > I'll talk to Jeremy when he comes back from vacation.  I don't think
> > we have to write a precise document of this prototype
> > interface/implementation at this stage (it will surely change).  But
> > we can use it as a practice of how to make a useful document while
> > writing code.
> 
> Please let me know what you want from me. 
> 
> Also as I help write documentation, I can use the new interfaces to write 
> some microbenchmarking tests.

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/

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?

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

---
JINMEI, Tatuya