configuration file for generating code documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Smart Package Manager |
New
|
Wishlist
|
Rehan Khan |
Bug Description
Imported: http://
Reason: Review Patch
further details: https:/
msg958 (view) Author: dfarning Date: 2006-11-20.20:37:01
dox.patch replaces Dox1 and Doxyfile. Is this something you are interested in?
I don't want to spend to much time on it if it not useful.
msg861 (view) Author: dfarning Date: 2006-10-31.23:38:21
Attached is a diff that contains Doxyfile, Doxy stubs for smart.__init__, and a
formatted version of README as the Doxy main page.
For some reason, caller and called information is not being displayed correctly.
I am not sure if the problem is the python parser in 1.5.1 or something in the
smart code.
msg841 (view) Author: dfarning Date: 2006-10-28.18:34:49
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://
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://
The html output tries to hard to be pretty.
http://
I like the simpler format used by pygtk at
http://
Dave