Doxygen Links http www itk orgDoxygenhtmlclasses html http

Links • • http: //www. itk. org/Doxygen/html/classes. html http: //www. itk. org/Doxygen/html/classitk_1_1 Image. html

Documentation Generation • Requirements: – Doxygen – Dot (recommended) – La. Te. X •

Documentation Generation • Process – CMake time • When scanning modules – generate dot

Documentation Generation • Turn ON BUILD_DOCUMENTATION – Check Doxygen / Dot if are installed

Documentation Generation • Turn ON BUILD_DOCUMENTATION – Once to generate the configuration file –

Errors / Warnings • Doxygen can – Fail (rare) – Warn about inconsistencies!! •

Module Documentation set(DOCUMENTATION "This module contains the central classes of the ITK toolkit. They

Module Documentation itk_module(ITK-Common DEPENDS ITK-VNLInstantiation ITK-KWSys TEST_DEPENDS ITK-Test. Kernel ITK-Mesh ITK-Image. Intensity ITK-IO-Base DESCRIPTION

Module Documentation • For each class in ITK, the Module Name MUST be provided

Crowd Sourcing • Online editing of doxygen documentation – To be connected (Kitware) (=>JIRA)

Wiki Examples • Automated script which add links in header files wikiexample{Simple. Operations/Set. Pixels,

Few Commands • • • class brief tparam return code li sa ingroup class

Few Commands • • • class brief tparam return code li sa ingroup param[in]

Few Commands • • • class brief tparam return code li sa ingroup return

Few Commands • • • class brief tparam return code li sa ingroup code

Few Commands • • • class brief tparam return code li sa ingroup

Tweaks (needs) • Font Size • Font • etc. • Firefox with Firebug extension

Slides: 21

Download presentation

Doxygen

Links • • http: //www. itk. org/Doxygen/html/classes. html http: //www. itk. org/Doxygen/html/classitk_1_1 Image. html http: //www. itk. org/Doxygen/html/modules. html http: //www. stack. nl/~dimitri/doxygen/commands. html

Documentation Generation • Requirements: – Doxygen – Dot (recommended) – La. Te. X • it is not tested if installed (=> JIRA)

Documentation Generation • Process – CMake time • When scanning modules – generate dot file for each module for dependency » TODO: use doxygen dot command instead (=>JIRA) – generate a dox file for each module » each module MUST be documented after keyword DESCRIPTION in itk_module. cmake » dependency documented

Documentation Generation • Turn ON BUILD_DOCUMENTATION – Check Doxygen / Dot if are installed – Generate doxygen. config from doxygen. config. in – Create an additional target Documentation which is added to all • Make Documentation or make all o at first generate all html pages (single threaded) o o From *. h generate all graphs (multi threaded and use all core on your machines)

Documentation Generation • Turn ON BUILD_DOCUMENTATION – Once to generate the configuration file – Configure & Generate (CMake) (=> JIRA) • Turn OFF BUILD_DOCUMENTATION • cd build directory $ /path/to/source/ITK/Utilities/Maintenance/sin gle-doxygen. sh /path/to/source/ITK/Modules/Core/Common/i nclude

Errors / Warnings • Doxygen can – Fail (rare) – Warn about inconsistencies!! • Nightly Dashboard – Check snapper. megason-lab. hms – All doxygen warnings appear as a single 1

Module Documentation set(DOCUMENTATION "This module contains the central classes of the ITK toolkit. They include, basic data structures (such as Points, Vectors, Images, Regions) the core of the process objects (such as base classes for image filters) the pipeline infrastructure classes, the support for multi-threading, and a collection of classes that isolate ITK from platform specific features. It is anticipated that most other ITK modules will depend on this one. ”)

Module Documentation itk_module(ITK-Common DEPENDS ITK-VNLInstantiation ITK-KWSys TEST_DEPENDS ITK-Test. Kernel ITK-Mesh ITK-Image. Intensity ITK-IO-Base DESCRIPTION "${DOCUMENTATION}” ) Automated generation of a dependency graph image Description of a module

Module Documentation • For each class in ITK, the Module Name MUST be provided ingroup ITK-Common • If not => Test failure

Crowd Sourcing • Online editing of doxygen documentation – To be connected (Kitware) (=>JIRA) • Wiki Examples

Wiki Examples • Automated script which add links in header files wikiexample{Simple. Operations/Set. Pixels, Set specified pixels to specified values} endwiki

Few Commands • • • class brief tparam return code li sa ingroup class Image brief Templated n-dimensional image class. tparam TPixel Type tparam VImage. Dimension Image Dimension template< class TPixel, unsigned int VImage. Dimension > class Image

Few Commands • • • class brief tparam return code li sa ingroup param[in] Parameter description param[out] Parameter description param[in, out] Parameter description

Few Commands • • • class brief tparam return code li sa ingroup return Description of the return value

Few Commands • • • class brief tparam return code li sa ingroup code typedef itk: : Image< unsigned char, 2 > Image. Type; … endcode

Few Commands • • • class brief tparam return code li sa ingroup

Tweaks (needs) • Font Size • Font • etc. • Firefox with Firebug extension (consensus)