To work on this bug you will have to branch from/merge into
bug-8203-provide-module-documentation
What should (at least) be done:
Add the following folders to the module.
If no module fits add it to an appropriate bundle.
Modules/YourModuleName/Documentation/doxygen/
for any files describing how to interact with the module as a developer
Modules/YourModuleName/Documentation/UserManual/
for any files describing how to interact with the module as a user
and the file
Modules/YourModuleName/Documentation/doxygen/DiffusionImagingProperties.dox
A template of the property page including some of what should be explained therein:
/**
\page PointSetPropertiesPage The Point Set Properties
TODO
close contour - toggles whether first and last point of the contour are connected (if drawn)
contourcolor - color of the contour (if active)
contoursize - how thick is the contour (if active)
distance decimal digits - if show distance is active, how decimal places are
shown
point 2D size - in 2D, how big are the points (how long are the arms of the
crosses)
point line width - in 2D how thick are the lines
pointsize - in 3D - control the sphere radius
selectedcolor - colour the selected points are drawn in
show angles - if contour, print angle between two pieces
show contour - draw connecting pieces between dots
show distance lines - show angles/lines even if not on current slice
show distances - draw length of connecting elements
show points - toggle points
updateDataOnRender - ???
*/
Additionally you will need to add your page to
\MITK\Documentation\Doxygen\Modules.dox
as a subpage by as demonstrated by
\subpage PropertiesPage