Commit 85c34c7e authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] added documentation for AtlasSurfaces module.

parent 99756e29
......@@ -88,10 +88,10 @@ const std::string WMAtlasSurfaces::getName() const
const std::string WMAtlasSurfaces::getDescription() const
{
// Specify your module description here. Be detailed. This text is read by the user.
// See "src/modules/template/" for an extensively documented example.
return "Someone should add some documentation here. "
"Probably the best person would be the modules's creator, i.e. \"schurade\"";
return "Use a scalar data set that stores numbers for atlas regions and a "
"correspoding text file with labels for the numbers to create "
"surfaces bounding the atlas regions. The surfaces can be picked to reveal "
"their name in the HUD (module). Regions can be used as ROIs for fiber selection.";
}
void WMAtlasSurfaces::connectors()
......
......@@ -44,13 +44,8 @@ class WDataSetScalar;
/**
* Someone should add some documentation here.
* Probably the best person would be the module's
* creator, i.e. "schurade".
*
* This is only an empty template for a new module. For
* an example module containing many interesting concepts
* and extensive documentation have a look at "src/modules/template"
* Create surface representation of atlas from volumetric atlas file
* and text file with labels for atlas regions.
*
* \ingroup modules
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment