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

[Jeremy C. Reed]

Some more examples:

LDNS Documentation (Introduction)
http://www.nlnetlabs.nl/projects/ldns/doc/index.html

Design
http://www.nlnetlabs.nl/projects/ldns/doc/design.html

Data Structures
http://www.nlnetlabs.nl/projects/ldns/doc/annotated.html

Files
http://www.nlnetlabs.nl/projects/ldns/doc/files.html

and an individual file
http://www.nlnetlabs.nl/projects/ldns/doc/buffer_8c.html

Tutorial
http://www.nlnetlabs.nl/projects/ldns/doc/tutorial1_mx.html

(and other documentation pages too)

This is generated using doxygen. Here is another example of ldns 
documentation rendered differently (by doxygen):
http://ldns.sourcearchive.com/documentation/1.5.1-1/design.html

Here are examples of pyLDNS docs:
http://www.fit.vutbr.cz/~slany/nic-vip/pyldns/modules/ldns.html
http://www.fit.vutbr.cz/~slany/nic-vip/pyldns/modules/ldns_resolver.html
http://www.fit.vutbr.cz/~slany/nic-vip/pyldns/
http://www.fit.vutbr.cz/~slany/nic-vip/pyldns/examples/example1.html
and others

pyLDNS docs are generated using Sphinx (python documentation generator).
http://sphinx.pocoo.org/
It is the generator for Python's official docs too:
http://docs.python.org/dev/documenting/index.html
(I can not tell if it is used to self-document code / embedding docs in 
code.)

pydoc is the documentation generator and online help system for 
documenting python modules.
http://docs.python.org/dev/library/pydoc.html?highlight=pydoc#module-pydoc