Commit 1df71e34 authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] less than fifty errors again

parent 38b71471
......@@ -610,7 +610,8 @@ RECURSIVE = YES
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = src/dataHandler/io/nifti \
src/dataHandler/io/biosig
src/dataHandler/io/biosig \
src/common/platformDependent/visualStudio/inttypes.h
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
......
......@@ -147,12 +147,12 @@ ADD_CUSTOM_TARGET( doc
)
# NOTE: this full documentation also includes call/caller graphs, colaboration graphs and nicer inheritance graphs
# but need "dot" from graphviz to render them.
# but needs "dot" from graphviz to render them.
ADD_CUSTOM_TARGET( fulldoc
COMMAND doxygen ${PROJECT_SOURCE_DIR}/../doc/developer/doxygenConfigFull
COMMAND chmod -R g+r ${PROJECT_SOURCE_DIR}/../doc/developer/html
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/..
COMMENT "Build doxygen documentation"
COMMENT "Build verbose doxygen documentation"
VERBATIM
)
......
......@@ -58,6 +58,9 @@ public:
TS_ASSERT( p2.isDetermined() );
}
/**
* Test whether finish() sets pending to false.
*/
void testFinish()
{
// this instance should be pending
......
......@@ -216,7 +216,8 @@ public:
wmath::WMatrix<double> getTransformationMatrix() const;
/**
* Transforms coordinates from world to texture space
* Transforms texture coordinates according to transforation of the grid.
* \param point The point with these coordinated will be transformed.
*/
wmath::WVector3D transformTexCoord( wmath::WPosition point );
......@@ -334,6 +335,11 @@ public:
protected:
private:
/**
* Return the id of the sample along axis for a given position.
* \param pos The id will be computed for this position
* \param axis Id of the axis along which the corresponding voxel is searched.
*/
int getNVoxelCoord( const wmath::WPosition& pos, size_t axis ) const;
wmath::WPosition m_origin; //!< Origin of the grid.
......
......@@ -126,7 +126,7 @@ private:
std::string m_handicaps; //!< Description of the handicaps of the person.
Sex m_sex; //!< The gender of the person.
// TODO(wiebel): Should better be something like dotnet's System.Nullable<byte>
char m_categoryId;
char m_categoryId; //!< not documented.
std::string m_handedness; //!< preference for using right or left hand
std::string m_notes; //!< Notes.
std::string m_diagnostic; //!< The diagnosis for the person.
......
......@@ -56,11 +56,15 @@ class WPickHandler: public osgGA::GUIEventHandler
public:
/**
* Deals with the events found by the osg.
* \param ea Event class for storing Keyboard, mouse and window events.
* \param aa Interface by which GUIEventHandlers may request actions of the GUI system
*/
bool handle( const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& aa );
/**
* Send a pick signal with the pick information as string
* \param view the view in which we pick.
* \param ea Event class for storing Keyboard, mouse and window events.
*/
virtual void pick( osgViewer::View* view, const osgGA::GUIEventAdapter& ea );
......
......@@ -77,9 +77,9 @@ public:
void clearNonPersistentTabs();
protected:
private:
std::map< QString, WQtMenuPage*> m_tabList;
std::map< QString, WQtMenuPage*> m_tabList; //!< List holding the widgets representing the tabs of the menu.
std::map< QString, WQtPushButton*> m_buttonList;
std::map< QString, WQtPushButton*> m_buttonList; //!< List holding the buttons that appear in the menu.
QTabWidget* m_tabWidget; //!< The tab widget beeing the basis for the ribbon menu.
};
......
......@@ -47,7 +47,7 @@ WBatchLoader::~WBatchLoader()
void WBatchLoader::run()
{
// the module needs to be add here, as it else could be freed before the thread finishes ( remember: it is a shared_ptr).
// the module needs to be added here, as it else could be freed before the thread finishes ( remember: it is a shared_ptr).
m_targetContainer->addPendingThread( shared_from_this() );
// actually run
......
......@@ -251,9 +251,14 @@ private:
*/
WTriangleMesh load( std::string fileName );
// TODO(wiebel): MC need to document and rename this
/**
* Kind of a convenience function for generate surface.
* It performs the conversions of the value sets of different data types.
* \param isoValue The surface will represent this value.
*/
void generateSurfacePre( double isoValue );
boost::shared_ptr< const WDataSetSingle > m_dataSet;
boost::shared_ptr< const WDataSetSingle > m_dataSet; //!< pointer to dataSet to be able to access it throughout the whole module.
boost::shared_ptr< WGridRegular3D > m_grid; //!< pointer to grid, because we need to access the grid for the dimensions of the texture.
......
......@@ -99,17 +99,29 @@ protected:
*/
virtual void properties();
/**
* Creates the geode that contains the lines representing the fibers.
*/
osg::ref_ptr< osg::Geode > genFiberGeode() const;
/**
* Coordinates all the work that is needed if the input changes.
*/
void update();
/**
* Builds an OSG geode where all voxels inside the dataSet which are not
* zero are drawn as cuboids.
* \param dataset contains the rasterized fibers.
*
* \return OSG Geode with the voxels as cuboids.
*/
osg::ref_ptr< osg::Geode > genDataSetGeode( boost::shared_ptr< WDataSetSingle > dataset ) const;
/**
* Uses bresenham provided for rasterizing the fibers in a loop.
* \param algo The rasterizer.
*/
void raster( boost::shared_ptr< WBresenham > algo ) const;
/**
......@@ -121,6 +133,11 @@ protected:
*/
std::pair< wmath::WPosition, wmath::WPosition > createBoundingBox( const WFiberCluster& cluster ) const;
/**
* Generate the graphical representation of the bounding box-
* \param fll front lower left, i.e. minimum coordinate corner
* \param bur back upper right, i.e. maximum coordinate corner
*/
osg::ref_ptr< osg::Geode > genBBGeode( const wmath::WPosition& fll,
const wmath::WPosition& bur ) const;
......
......@@ -76,6 +76,7 @@ public:
protected:
/**
* Marks a given voxel as hit.
* \param voxel thre numbers inidcating the id along the x, y and z axis.
*/
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