[bind10-dev] doxygen samples

JINMEI Tatuya / 神明達哉 jinmei at isc.org
Fri Oct 23 00:14:11 UTC 2009


I've played with doxygen markups based on the (experimental) design
document for the DNS Name class:
http://bind10.isc.org/wiki/NameClassDesign#TheNameClass

Snapshot examples of HTML output generated by doxygen are
(tentatively) available here:
http://www.jinmei.org/bind10/api/index.html
(many of the pages under the top page are just indices and boring,
except these two:
http://www.jinmei.org/bind10/api/class_i_s_c_1_1_d_n_s_1_1_name.html
http://www.jinmei.org/bind10/api/class_i_s_c_1_1_d_n_s_1_1_name_comparison_result.html)

The corresponding header file has been committed to a separate branch
of the svn repository:
http://bind10.isc.org/browser/branches/jinmei-doxygentrial/src/lib/dns/name.h

I do not necessarily think it's easy to use, but if we have no better
alternative to help keep the implementation and documentation
consistent, I can live with that.  At least the resulting HTML files
seem reasonable to me.

Assuming we'll use doxygen, my next question is how to integrate the
doxygen-generated HTML files into the trac site.  Ideally the former
is auto-generated on svn commit or periodically, and we'll add links
from trac documents to the doxygen HTML files.

---
JINMEI, Tatuya



More information about the bind10-dev mailing list