Commit a67006c7 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC] added and improved documentation of de/constructors

parent 0378ecc1
......@@ -52,8 +52,9 @@ protected:
private:
/**
* Stores the all components of all vertices of all tracts. First x, y and finally z component
* are arranged in this manner: \f$[x_0, y_0, z_0, ..., x_{m_0}, y_{m_0}, z_{m_0}, ... , ..., x_{m_k},
* y_{m_k}, z_{m_k}]\f$ where there are \f$k\f$ many tracts where the i'th tract has \f$m_i\f$
* are arranged in this manner:
* \f$[x_0, y_0, z_0, ..., x_{m_0}, y_{m_0}, z_{m_0}, ... , ..., x_{m_k}, y_{m_k}, z_{m_k}]\f$
* where there are \f$k\f$ many tracts where the i'th tract has \f$m_i\f$
* vertices, but \f$3m_i\f$ compontents. In other words: m_points.size() / 3 == number of
* vertices.
*
......
......@@ -64,6 +64,9 @@ public:
*/
explicit WJoinContourTree( std::shared_ptr< WDataSetSingle > dataset );
/**
* Destructor
*/
WJoinContourTree();
/**
......
......@@ -49,6 +49,9 @@ public:
*/
typedef osg::ref_ptr< WROI > RefPtr;
/**
* Standard constructor
*/
WROI();
/**
......
......@@ -55,6 +55,9 @@ public:
*/
WROIBox( WPosition minPos, WPosition maxPos );
/**
* Destructor
*/
virtual ~WROIBox();
/**
......
......@@ -51,12 +51,12 @@ class WMArbitraryROIs: public WModule
{
public:
/**
*
* Standard constructor
*/
WMArbitraryROIs();
/**
*
* Destructor
*/
virtual ~WMArbitraryROIs();
......
......@@ -75,12 +75,12 @@ class WMClusterDisplayVoxels: public WModule
{
public:
/**
*
* Standard constructor
*/
WMClusterDisplayVoxels();
/**
*
* Destructor
*/
virtual ~WMClusterDisplayVoxels();
......
......@@ -44,12 +44,12 @@ class WMReadSphericalHarmonics: public WModule
{
public:
/**
*
* Standard constructor
*/
WMReadSphericalHarmonics();
/**
*
* Destructor
*/
virtual ~WMReadSphericalHarmonics();
......
......@@ -55,13 +55,12 @@ WMDatasetProfile::~WMDatasetProfile()
std::shared_ptr< WModule > WMDatasetProfile::factory() const
{
// See "src/modules/template/" for an extensively documented example.
return std::shared_ptr< WModule >( new WMDatasetProfile() );
}
const char** WMDatasetProfile::getXPMIcon() const
{
return WMDatasetProfile_xpm; // Please put a real icon here.
return WMDatasetProfile_xpm;
}
const std::string WMDatasetProfile::getName() const
{
......
......@@ -45,26 +45,19 @@ const unsigned int MASK_2D = 0xF0000000; //!< used for osgWidget stuff
const unsigned int MASK_3D = 0x0F000000; //!< used for osgWidget stuff
/**
* 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"
*
* Shows values along a 3D profile through the dataset as a graph.
* \ingroup modules
*/
class WMDatasetProfile: public WModule
{
public:
/**
*
* Standard constructor
*/
WMDatasetProfile();
/**
*
* Destructor
*/
virtual ~WMDatasetProfile();
......
......@@ -65,12 +65,12 @@ class WMPartition2Mesh: public WModule
{
public:
/**
*
* Standard constructor
*/
WMPartition2Mesh();
/**
*
* Destructor
*/
virtual ~WMPartition2Mesh();
......
......@@ -53,8 +53,14 @@ typedef std::shared_ptr<WDataSetScalar> WDataSetScalarSPtr;
class WIGTLinkRemote : public WThreadedRunner
{
public:
/**
* Standard constructor
*/
WIGTLinkRemote();
/**
* Destructor
*/
virtual ~WIGTLinkRemote();
/**
......
......@@ -52,12 +52,12 @@ class WMOpenIGTLinkSender: public WModule
{
public:
/**
*
* Standard constructor
*/
WMOpenIGTLinkSender();
/**
*
* Destructor
*/
virtual ~WMOpenIGTLinkSender();
......
......@@ -56,12 +56,12 @@ class WMPaintTexture: public WModule
{
public:
/**
*
* Standard constructor
*/
WMPaintTexture();
/**
*
* Destructor
*/
virtual ~WMPaintTexture();
......
......@@ -49,12 +49,12 @@ class WMReadMesh: public WModule
{
public:
/**
*
* Standard constructor
*/
WMReadMesh();
/**
*
* Destructor
*/
virtual ~WMReadMesh();
......
......@@ -43,12 +43,12 @@ class WMTransferFunction1D: public WModule
{
public:
/**
*
* Standard constructor
*/
WMTransferFunction1D();
/**
*
* Destructor
*/
virtual ~WMTransferFunction1D();
......
......@@ -43,12 +43,12 @@ class WMVectorAlign: public WModule
{
public:
/**
*
* Standard constructor
*/
WMVectorAlign();
/**
*
* Destructor
*/
virtual ~WMVectorAlign();
......
......@@ -37,13 +37,7 @@
#include "core/kernel/WModuleOutputData.h"
/**
* 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"
* Writing a mesh in the format of the software Amira
*
* \ingroup modules
*/
......@@ -51,12 +45,12 @@ class WMWriteAmiraMesh: public WModule
{
public:
/**
*
* Standard constrcutor
*/
WMWriteAmiraMesh();
/**
*
* Destructor
*/
virtual ~WMWriteAmiraMesh();
......
......@@ -51,12 +51,12 @@ friend class WMWriteMeshTest;
public:
/**
*
* Standard constructor
*/
WMWriteMesh();
/**
*
* Destructor
*/
virtual ~WMWriteMesh();
......
......@@ -44,8 +44,14 @@
class WQtNetworkPort : public QGraphicsRectItem
{
public:
/**
* Standard constructor
*/
WQtNetworkPort();
/**
* Destructor
*/
~WQtNetworkPort();
/**
......
......@@ -8,7 +8,7 @@ $header = <<EOF
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2017 OpenWalnut Community
// Copyright 2022 OpenWalnut Community
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
......@@ -54,12 +54,12 @@ class WM#name#: public WModule
{
public:
/**
*
* Standard contrucor
*/
WM#name#();
/**
*
* Destructor
*/
virtual ~WM#name#();
......
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