[bind10-dev] doxygen samples

[JINMEI Tatuya / 神明達哉]

At Thu, 22 Oct 2009 20:41:27 -0500 (CDT),
"Jeremy C. Reed" <jreed at isc.org> wrote:

> > I do not necessarily think it's easy to use, but if we have no better
> 
> Any specific examples of why or where it is not easy?

- learning the strange markups such as //@{, //@}, \XXX, //! :-)
  (and no, ":-)" is not part of markups:-)
- figuring out configuration knobs for Doxyfile along with the markups
  to achieve intended output.  For example, it took time for me to
  find how to show "Constructor & Desctructor Documentation",
  especially because these didn't have "detailed descriptions".

I admit its manual is generally well-written, btw.  I mainly referred
to a quick demonstration page:
http://www.stack.nl/~dimitri/doxygen/docblocks.html
(and some part of reference manuals when necessary)

and live examples of Xerces-C:
http://xerces.apache.org/xerces-c/apiDocs-3/classes.html

> > 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.
> 
> There is a doxygen plugin for Trac. Basically it just adds the HTML 
> pages to the Trac website.
> 
> http://trac-hacks.org/wiki/DoxygenPlugin
> 
> I can install and enable this on our Trac server.

Then let's try it.

---
JINMEI, Tatuya