Difference between revisions of "ITK/Doxygen Documentation"

From KitwarePublic
< ITK
Jump to navigationJump to search
Line 1: Line 1:
== Generation ==
== Dependencies ==


Generating a complete doxygen documentation requires (apart from cmake and ITK source code)
Generating a complete doxygen documentation requires (apart from cmake and ITK source code)
Line 6: Line 6:
* '''dot''' from GraphViz for generating inheritance and dependency graph (see http://www.graphviz.org/)
* '''dot''' from GraphViz for generating inheritance and dependency graph (see http://www.graphviz.org/)
* '''latex''' for formulas (see http://www.latex-project.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?
== Maintaining the documentation ==
== Suppressing and preventing Doxygen warnings ==

Revision as of 15:01, 9 May 2011

Dependencies

Generating a complete doxygen documentation requires (apart from cmake and ITK source code)

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?

Maintaining the documentation

Suppressing and preventing Doxygen warnings