[issue238] PATCH DOXYGEN configuration file for generating code documentation

[David Farning at Labix Tracker]

New submission from David Farning <dfarning at gmail.com>:

Attached is a sample configuration file for generating documentation with doxygen.

To use:
install doxygen graphviz
copy Doxyfile into the smart directory
from the smart directory run doxygen

The resulting html files will be in doc/html (sbout 20M worth including the
various graphs)

PROS:
The call graphs and hyperlinks make reading and understanding the code much easier.

Doxygen is stable and well documented at
http://www.stack.nl/~dimitri/doxygen/manual.html

By placing the auto generated generated html documentation on the smart web site
user will allways have the lastest documentation.

CONS:
In order to use all of the features of doxygen you can't use standard python doc
strings.  http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks

The html output tries to hard to be pretty. 
http://www.stack.nl/~dimitri/doxygen/examples/docstring/html/classdocstring_1_1PyClass.html

 I like the simpler format used by pygtk at
http://www.pygtk.org/docs/pygtk/class-gtkbutton.html

Dave

----------
files: Doxyfile
messages: 841
nosy: dfarning
priority: wish
project: smart
status: unread
title: PATCH DOXYGEN configuration file for generating code documentation

_______________________________________
Labix issue tracker <tracker at labix.org>
<http://tracker.labix.org/issue238>
_______________________________________
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Doxyfile
Type: application/octet-stream
Size: 10176 bytes
Desc: not available
URL: <http://lists.labix.org/pipermail/smart-labix.org/attachments/20061028/dfa26b8f/attachment-0002.obj>