ITK/Doxygen Documentation: Difference between revisions
From KitwarePublic
< ITK
Jump to navigationJump to search
Arnaudgelas (talk | contribs) |
Arnaudgelas (talk | contribs) |
||
| Line 14: | Line 14: | ||
* In CMake '''BUILD_DOCUMENTATION''' must be turned '''ON''' !! | * In CMake '''BUILD_DOCUMENTATION''' must be turned '''ON''' !! | ||
* Build the project as you would normally do, it will build both the ITK libraries/binaries and the doxygen documentation | |||
Note that depending on your machine, this process can take a lot time. | Note that depending on your machine, this process can take a lot time. | ||
| Line 22: | Line 23: | ||
* In CMake '''BUILD_DOCUMENTATION''' and '''DOXYGEN_MODULE_ENABLED''' must be turned '''ON''' !! | * In CMake '''BUILD_DOCUMENTATION''' and '''DOXYGEN_MODULE_ENABLED''' must be turned '''ON''' !! | ||
* Build the project as you would normally do, it will build both the ITK libraries/binaries and the doxygen documentation | |||
== Documenting classes and functions == | == Documenting classes and functions == | ||
Revision as of 16:01, 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
Complete doxygen documentation
To generate the complete doxygen documentation (of the whole toolkit), the same as the online doxygen documentation
- In CMake BUILD_DOCUMENTATION must be turned ON !!
- Build the project as you would normally do, it will build both the ITK libraries/binaries and the doxygen documentation
Note that depending on your machine, this process can take a lot time.
Enabled modules documentation
To generate the doxygen documentation of enabled modules documentation (a subset of the complete one)
- In CMake BUILD_DOCUMENTATION and DOXYGEN_MODULE_ENABLED must be turned ON !!
- Build the project as you would normally do, it will build both the ITK libraries/binaries and 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.
