Commit b6fa78ee authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] added some documentation for a couple of modules.

parent 85c34c7e
......@@ -75,7 +75,7 @@ const std::string WMArbitraryPlane::getName() const
const std::string WMArbitraryPlane::getDescription() const
{
return "Modul draws an arbitrarily moveable plane through the brain. That rhymes.";
return "Module draws an arbitrarily moveable plane through the data.";
}
void WMArbitraryPlane::connectors()
......
......@@ -38,13 +38,7 @@
#include "core/kernel/WModuleOutputData.h"
/**
* 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"
* Arbitrarily orientable cutting plane through the data.
*
* \ingroup modules
*/
......
......@@ -81,9 +81,9 @@ const std::string WMArbitraryRois::getName() const
const std::string WMArbitraryRois::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. ";
return "Create non uniformly shaped ROIs for fiber selection. The ROI "
"is what is enclosed by a surface created as isosurface from "
"the data within a ROI box.";
}
void WMArbitraryRois::connectors()
......
......@@ -43,13 +43,7 @@ class WROIBox;
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 non uniformly shaped ROIs for fiber selection.
*
* \ingroup modules
*/
......
......@@ -70,7 +70,7 @@ const std::string WMDatasetManipulator::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 "This module allows manipulation of the dataset properties via manipulators in the 3D scene";
return "This module allows manipulation of the dataset properties via manipulators in the 3D scene.";
}
void WMDatasetManipulator::connectors()
......
......@@ -36,13 +36,7 @@
#include "core/kernel/WModuleOutputData.h"
/**
* 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"
* Module allowing manipulation of the dataset properties via manipulators in the 3D scene.
*
* \ingroup modules
*/
......
......@@ -41,13 +41,8 @@
#include "core/graphicsEngine/WGETexture.h"
/**
* 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"
* This module allows mark areas in a 3D texture by "painting"
* on pickable surfaces.
*
* \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