Commit 0a897476 authored by Mathias Goldau's avatar Mathias Goldau

[DOC #186] Fixed some doxygen warnings

parent 8148ee72
......@@ -524,7 +524,7 @@ WARN_FORMAT = "$file:$line: $text"
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE = doc/developer/doxyerror.log
# WARN_LOGFILE = doc/developer/doxyerror.log
#---------------------------------------------------------------------------
# configuration options related to the input files
......
......@@ -38,7 +38,9 @@
// information. Since we don't have the possibility of multiple
// InputConnectors we must agglomerate those into one object. Please remove this.
// initializes the variable and provides a linker reference
// \cond
boost::shared_ptr< WPrototyped > WFiberCluster::m_prototype = boost::shared_ptr< WPrototyped >();
// \endcond
WFiberCluster::WFiberCluster()
: WTransferable()
......@@ -62,6 +64,8 @@ void WFiberCluster::merge( WFiberCluster& other ) // NOLINT
other.clear();
}
// NODOXYGEN
// \cond
void WFiberCluster::setDataSetReference( boost::shared_ptr< const WDataSetFibers > fibs )
{
m_fibs = fibs;
......@@ -84,3 +88,4 @@ boost::shared_ptr< WPrototyped > WFiberCluster::getPrototype()
}
return m_prototype;
}
// \endcond
......@@ -108,7 +108,7 @@ public:
* The only reason for implementing is here, to prevent this class from
* beeing abstract.
*
*\return A name.
* \return A name.
*/
virtual const std::string getName() const;
......@@ -116,7 +116,7 @@ public:
* The only reason for implementing is here, to prevent this class from
* beeing abstract.
*
*\return A name.
* \return A name.
*/
virtual const std::string getDescription() const;
......@@ -138,6 +138,8 @@ public:
// dataset is, we need it in the WMVoxelizer module as well as the clustering
// information. Since we don't have the possibility of multiple
// InputConnectors we must agglomerate those into one object. Please remove this.
// DISABLE DOXYGEN HERE
// \cond
void setDataSetReference( boost::shared_ptr< const WDataSetFibers > fibs );
boost::shared_ptr< const WDataSetFibers > getDataSetReference() const;
static boost::shared_ptr< WPrototyped > getPrototype();
......@@ -148,6 +150,8 @@ protected:
// information. Since we don't have the possibility of multiple
// InputConnectors we must agglomerate those into one object. Please remove this.
static boost::shared_ptr< WPrototyped > m_prototype;
// \endcond
// ENDABLE DOXYGEN HERE
private:
......
......@@ -334,6 +334,16 @@ public:
protected:
private:
/**
* Computes for the n'th component of the voxel coordinate where the voxel
* contains the position pos.
*
* \param pos The position for which the n'th component of the voxel
* coordinates should be computed.
* \param axis The number of the component. (0 == x-axis, 1 == y-axis, ...)
*
* \return The n'th component of the voxel coordinate
*/
int getNVoxelCoord( const wmath::WPosition& pos, size_t axis ) const;
wmath::WPosition m_origin; //!< Origin of the grid.
......
......@@ -44,8 +44,8 @@ public:
/**
* Constructs basic Loader with a file name.
*
*\param fileName Path to be loaded
*\throw WDHIOFailure in case of an error
* \param fileName Path to be loaded
* \throw WDHIOFailure in case of an error
*/
explicit WLoader( std::string fileName ) throw( WDHIOFailure );
......
......@@ -197,8 +197,8 @@ namespace wge
/**
* Converts a WColor to an OSG compatible color
*
*\param color The color in WColor format
*\return A color which may be used inside of OSG
* \param color The color in WColor format
* \return A color which may be used inside of OSG
*/
osg::Vec4 osgColor( const WColor& color );
......
......@@ -68,7 +68,7 @@ public:
/**
* Delivers a reference to the last point.
*
*\return Reference of the last point.
* \return Reference of the last point.
*/
const WPosition& back() const;
......
......@@ -129,7 +129,7 @@ private:
* Checks if the look up table exists. This is done via the original file
* name containing the fibers but different suffix.
*
*\return True if it look up table detection was successfull.
* \return True if it look up table detection was successfull.
*/
bool dLtTableExists();
......@@ -155,7 +155,7 @@ private:
/**
* For each cluster a dataset is generated in which its fibers are blurred.
*
*\return Datasets containing the blurred clusters.
* \return Datasets containing the blurred clusters.
*/
boost::shared_ptr< WDataSetSingle > blurClusters() const;
......@@ -192,6 +192,9 @@ private:
*/
boost::shared_ptr< WModuleInputData< WDataSetFibers > > m_fiberInput;
/**
* Output connector for the first cluster.
*/
boost::shared_ptr< WModuleOutputData< WFiberCluster > > m_output;
/**
......
......@@ -39,6 +39,8 @@ class WBresenham : public WRasterAlgorithm
public:
/**
* Initializes new raster algo.
*
* \param grid The grid which defines the voxels which should be marked.
*/
explicit WBresenham( boost::shared_ptr< WGridRegular3D > grid );
......@@ -51,16 +53,16 @@ public:
* Rasterize the given line into the grid of dataset.
* The value of the voxel which will be hit changes its value.
*
*\param line Polyline which is about to be rastered.
* \param line Polyline which is about to be rastered.
*/
virtual void raster( const wmath::WLine& line );
protected:
/**
* Rasters a line segement of a polyline.
*
*
*\param start
*\param stop
* \param start Start point of the line segement.
* \param stop End point of the line segement.
*/
void rasterSegment( const wmath::WValue< int >& start, const wmath::WValue< int >& stop );
......
......@@ -42,7 +42,7 @@
#include "../../kernel/WKernel.h"
#include "../../math/WFiber.h"
#include "../../utils/WColorUtils.h"
#include "WBresenham.h"
#include "WBresenhamDBL.h"
#include "WMVoxelizer.h"
#include "WRasterAlgorithm.h"
......@@ -146,7 +146,7 @@ void WMVoxelizer::update()
grid = boost::shared_ptr< WGridRegular3D >( new WGridRegular3D( nbPosX, nbPosY, nbPosZ, bb.first, 1, 1, 1 ) );
debugLog() << "Created grid of size: " << grid->size();
boost::shared_ptr< WBresenham > bresenham = boost::shared_ptr< WBresenham >( new WBresenham( grid ) );
boost::shared_ptr< WBresenhamDBL > bresenham = boost::shared_ptr< WBresenhamDBL >( new WBresenhamDBL( grid ) );
raster( bresenham );
boost::shared_ptr< WDataSetSingle > outputDataSet = bresenham->generateDataSet();
m_output->updateData( outputDataSet );
......@@ -156,7 +156,7 @@ void WMVoxelizer::update()
WKernel::getRunningKernel()->getGraphicsEngine()->getScene()->addChild( m_osgNode );
}
void WMVoxelizer::raster( boost::shared_ptr< WBresenham > algo ) const
void WMVoxelizer::raster( boost::shared_ptr< WBresenhamDBL > algo ) const
{
const WDataSetFibers& fibs = *m_clusters->getDataSetReference();
const std::list< size_t >& fiberIDs = m_clusters->getIndices();
......
......@@ -34,7 +34,7 @@
#include "../../dataHandler/WDataSetSingle.h"
#include "../../kernel/WModule.h"
#include "../../kernel/WModuleInputData.h"
#include "WBresenham.h"
#include "WBresenhamDBL.h"
#include "WRasterAlgorithm.h"
/**
......@@ -99,28 +99,57 @@ protected:
*/
virtual void properties();
/**
* Generates an OSG geode for the fibers in the given cluster to display
* only this cluster.
*
* \return OSG geode containing the fibers of the cluster.
*/
osg::ref_ptr< osg::Geode > genFiberGeode() const;
/**
* Every parameter change this function is doing:
* - bounding box and grid generation
* - executing a rasterization algo for the fibers
* - generate dataset out of the grid and a value set
* - display the rastered voxels
*/
void update();
/**
* Builds an OSG geode where all voxels inside the dataSet which are not
* zero are drawn as cuboids.
*
* \param dataset The dataset which should be drawn
*
* \return OSG Geode with the voxels as cuboids.
*/
osg::ref_ptr< osg::Geode > genDataSetGeode( boost::shared_ptr< WDataSetSingle > dataset ) const;
void raster( boost::shared_ptr< WBresenham > algo ) const;
/**
* Performs rasterization with the given algorithm.
*
* \param algo The algorithm which actualy rasters every fiber.
*/
void raster( boost::shared_ptr< WBresenhamDBL > algo ) const;
/**
* Creates two vertices describing the bounding box of a cluster.
*
*\param cluster With its fibers
* \param cluster With its fibers
*
*\return Pair of WPositions: first == front lower left, second == back upper right
* \return Pair of WPositions: first == front lower left, second == back upper right
*/
std::pair< wmath::WPosition, wmath::WPosition > createBoundingBox( const WFiberCluster& cluster ) const;
/**
* Generates an OSG geode for the bounding box.
*
* \param fll Front lower left corner of the bounding box.
* \param bur Back upper right corner of the bounding box.
*
* \return The OSG geode containing the 12 edges of the box.
*/
osg::ref_ptr< osg::Geode > genBBGeode( const wmath::WPosition& fll,
const wmath::WPosition& bur ) const;
......
......@@ -47,6 +47,8 @@ public:
* Creates new raster algorithm within the given grid. The grid may later
* also be used to generate a real DataSet, \see generateDataSet() for
* furter instructions.
*
* \param grid The grid specifying the voxels.
*/
explicit WRasterAlgorithm( boost::shared_ptr< WGridRegular3D > grid );
......@@ -59,7 +61,7 @@ public:
* Rasterize the given line into the grid of dataset.
* The value of the voxel which will be hit changes its value.
*
*\param line Polyline which is about to be rastered.
* \param line Polyline which is about to be rastered.
*/
virtual void raster( const wmath::WLine& line ) = 0;
......@@ -67,7 +69,7 @@ public:
* Computes a dataset out of our voxel values and the previously given
* grid. Note this may take some time.
*
*\return Dataset where all voxels which are hit by the rastered lines are
* \return Dataset where all voxels which are hit by the rastered lines are
* non zero.
*/
boost::shared_ptr< WDataSetSingle > generateDataSet() const;
......@@ -75,6 +77,8 @@ public:
protected:
/**
* Marks a given voxel as hit.
*
* \param voxel The voxel coordinates
*/
virtual void markVoxel( const wmath::WValue< int >& voxel );
......
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