Page MenuHomePhabricator

Document the diffusion imaging properties
Closed, ResolvedPublic

Description

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 DiffusionImagingPropertiesPage The Diffusion Imaging Properties

TODO

opaclevelwindow - level window to control opacity
DisplayChannel - which channel is to be displayed
DoRefresh
IndexParam1
IndexParam2
Normalization
ScaleBy
Scaling
ShowMaxNumber
VisibleOdfs
VisibleOdfs_C
VisibleOdfs_S
VisibleOdfs_T

*/

Additionally you will need to add your page to
\MITK\Documentation\Doxygen\Modules.dox
as a subpage by as demonstrated by
\subpage PropertiesPage

Related Objects

Event Timeline

[255412]: Merge branch 'bug-8212-provide-diffusion-property-documentation'

Merged commits:

2011-08-03 18:03:17 Caspar Goch [afd022]
First property documentation for diff props

[32bf14]: Merge branch 'bug-8212-provide-diffusion-property-documentation'

Merged commits:

2011-08-17 15:47:30 Caspar Goch [4694f3]
Expanded documentation