Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
OpenWalnut
OpenWalnut Core
Commits
b6fa78ee
Commit
b6fa78ee
authored
Aug 24, 2011
by
Alexander Wiebel
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[DOC] added some documentation for a couple of modules.
parent
85c34c7e
Changes
7
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
10 additions
and
33 deletions
+10
-33
src/modules/arbitraryPlane/WMArbitraryPlane.cpp
src/modules/arbitraryPlane/WMArbitraryPlane.cpp
+1
-1
src/modules/arbitraryPlane/WMArbitraryPlane.h
src/modules/arbitraryPlane/WMArbitraryPlane.h
+1
-7
src/modules/arbitraryRois/WMArbitraryRois.cpp
src/modules/arbitraryRois/WMArbitraryRois.cpp
+3
-3
src/modules/arbitraryRois/WMArbitraryRois.h
src/modules/arbitraryRois/WMArbitraryRois.h
+1
-7
src/modules/datasetManipulator/WMDatasetManipulator.cpp
src/modules/datasetManipulator/WMDatasetManipulator.cpp
+1
-1
src/modules/datasetManipulator/WMDatasetManipulator.h
src/modules/datasetManipulator/WMDatasetManipulator.h
+1
-7
src/modules/paintTexture/WMPaintTexture.h
src/modules/paintTexture/WMPaintTexture.h
+2
-7
No files found.
src/modules/arbitraryPlane/WMArbitraryPlane.cpp
View file @
b6fa78ee
...
...
@@ -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
"Modul
e
draws an arbitrarily moveable plane through the
data
."
;
}
void
WMArbitraryPlane
::
connectors
()
...
...
src/modules/arbitraryPlane/WMArbitraryPlane.h
View file @
b6fa78ee
...
...
@@ -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
*/
...
...
src/modules/arbitraryRois/WMArbitraryRois.cpp
View file @
b6fa78ee
...
...
@@ -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
()
...
...
src/modules/arbitraryRois/WMArbitraryRois.h
View file @
b6fa78ee
...
...
@@ -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
*/
...
...
src/modules/datasetManipulator/WMDatasetManipulator.cpp
View file @
b6fa78ee
...
...
@@ -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
()
...
...
src/modules/datasetManipulator/WMDatasetManipulator.h
View file @
b6fa78ee
...
...
@@ -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
*/
...
...
src/modules/paintTexture/WMPaintTexture.h
View file @
b6fa78ee
...
...
@@ -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
*/
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment