[postgis-devel] Doxygen

Chris Hodgson chodgson at refractions.net
Fri May 17 10:53:19 PDT 2002


Further to the meeting this morning, we seem to have agreed on using
Doxygen-generated API docs. The Doxygen site is at:
http://www.stack.nl/~dimitri/doxygen/

And this page gives you a quick overview of how to document your code to take
advantage of it:
http://www.stack.nl/~dimitri/doxygen/docblocks.html#docblocks

Basically, if you are familiar with Javadoc comments, you can use exactly the
same technique for Doxygen. It is also very flexible and supports other
doc-comment styles such as the QT style (which I'm not personally aware of) and
some of its own, custom options.

Chris





More information about the postgis-devel mailing list