Commit 3513d8a8 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC] replaced dummy comments with correct documentation

parent 27174945
......@@ -66,8 +66,11 @@ const std::string WMEigenSystem::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 "No documentation yet. "
"The best person to ask for documenation is probably the modules's creator, i.e. \"math\"";
return "Computes the eigensystem of a second order tensor field."
" For each eigen vector and eigen value an output connector"
" field is available. If you need all you may connect to a "
"special output carrying all eigenvalues.";
}
void WMEigenSystem::connectors()
......
......@@ -37,13 +37,8 @@
class WDataSetScalar;
/**
* Someone should add some documentation here.
* Probably the best person would be the module's
* creator, i.e. "wiebel".
*
* 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"
* Evaluate different picking techniques with regard to certain metrics.
* Developed for paper: https://doi.org/10.1109/TVCG.2018.2848906
*
* \ingroup modules
*/
......
......@@ -38,14 +38,8 @@
class WDataSetDipoles;
/**
* Someone should add some documentation here.
* Probably the best person would be the module's
* creator, i.e. "wiebel".
*
* 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"
*
* Reading ".dip" files containing position and
* additional information on dipoles reconstructed from EEG.
* \ingroup modules
*/
class WMReadDipoles: public WModule
......
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