ITK/Doxygen Documentation: Difference between revisions
From KitwarePublic
< ITK
Jump to navigationJump to search
Daviddoria (talk | contribs) No edit summary |
Arnaudgelas (talk | contribs) |
||
| Line 16: | Line 16: | ||
Is there a way to create a dependency graph of the modules? | Is there a way to create a dependency graph of the modules? | ||
That would be great!! | |||
Right now, what's being done is that at cmake time, a doxygen page is generated and at the end of the page you have a "Dependencies" section with the list of dependent modules, and links to corresponding pages. | |||
== Maintaining the documentation == | == Maintaining the documentation == | ||
== Suppressing and preventing Doxygen warnings == | == Suppressing and preventing Doxygen warnings == | ||
Revision as of 15:09, 9 May 2011
Dependencies
Generating a complete doxygen documentation requires (apart from cmake and ITK source code)
- doxygen (see http://www.stack.nl/~dimitri/doxygen/index.html)
- dot from GraphViz for generating inheritance and dependency graph (see http://www.graphviz.org/)
- latex for formulas (see http://www.latex-project.org/)
Generating the Doxygen documentation
Documenting classes and functions
Creating links to wiki examples
Documenting modules
Is there a way to create a dependency graph of the modules?
That would be great!! Right now, what's being done is that at cmake time, a doxygen page is generated and at the end of the page you have a "Dependencies" section with the list of dependent modules, and links to corresponding pages.
