Difference between revisions of "ITK/Doxygen Documentation"

From KitwarePublic
< ITK
Jump to navigationJump to search
Line 8: Line 8:


== Generating the Doxygen documentation ==
== Generating the Doxygen documentation ==
* In CMake '''BUILD_DOCUMENTATION''' must be turned '''ON''' !!
By default, you'll generate the doxygen documentation of the whole toolkit, which depending on your machine can take a lot time.
If you are interested in generating the documentation of only the enabled modules, you should turn ON DOXYGEN_MODULE_ENABLED


== Documenting classes and functions ==
== Documenting classes and functions ==

Revision as of 10:54, 9 May 2011

Dependencies

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

Generating the Doxygen documentation

  • In CMake BUILD_DOCUMENTATION must be turned ON !!

By default, you'll generate the doxygen documentation of the whole toolkit, which depending on your machine can take a lot time.

If you are interested in generating the documentation of only the enabled modules, you should turn ON DOXYGEN_MODULE_ENABLED

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.

Maintaining the documentation

Suppressing and preventing Doxygen warnings