Commit 78db8a1d authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum

[DOC] - fixed doxygen warnings

parent 6332216f
......@@ -55,7 +55,7 @@ WGEViewer::WGEViewer( std::string name, osg::ref_ptr<osg::Referenced> wdata, int
: WGEGraphicsWindow( wdata, x, y, width, height ),
boost::enable_shared_from_this< WGEViewer >(),
m_name( name ),
m_rendered( WBoolFlag::SPtr( new WBoolFlag( new WConditionOneShot(), false) ) )
m_rendered( WBoolFlag::SPtr( new WBoolFlag( new WConditionOneShot(), false ) ) )
{
try
{
......
......@@ -252,7 +252,7 @@ protected:
*
* \param renderInfo render info object
*/
virtual void operator()( osg::RenderInfo& renderInfo ) const;
virtual void operator()( osg::RenderInfo& renderInfo ) const; // NOLINT - this is OSG API
/**
* Returns the queried vendor string.
......
......@@ -82,17 +82,23 @@ public:
void setupGUI();
/**
* returns a pointer to the network editor object
* Returns a pointer to the network editor object.
*
* \return the network editor instance
*/
WQtNetworkEditor* getNetworkEditor();
/**
* returns a pointer to the control panel object
* Returns a pointer to the control panel object.
*
* \return the control panel instance
*/
WQtControlPanel* getControlPanel();
/**
* Return icon manager
*
* \return the icon manager instance
*/
WIconManager* getIconManager();
......
......@@ -77,8 +77,10 @@ public:
virtual ~WQtGLWidget();
/**
* returns the recommended size for the widget to allow
* Returns the recommended size for the widget to allow
* parent widgets to give it a proper initial layout
*
* \return size hint of widget
*/
QSize sizeHint() const;
......
......@@ -226,6 +226,8 @@ protected:
/**
* Helper function to return the first subject id in the tree widget
*
* \return index of first subject in tree
*/
int getFirstSubject();
......
......@@ -32,25 +32,28 @@
#include "WQtModuleTreeItem.h"
/**
* TODO(schurade): Document this!
* This tree item represents a group of module items.
*/
class WQtModuleHeaderTreeItem : public QTreeWidgetItem
{
public:
/**
* TODO(schurade): Document this!
* Constructor. Creates module header.
*
* \param parent The widget managing this widget.
*/
explicit WQtModuleHeaderTreeItem( QTreeWidget * parent );
/**
* TODO(schurade): Document this!
* Destructor.
*/
virtual ~WQtModuleHeaderTreeItem();
/**
* Add an module to the tree view.
* \param module The new module.
*
* \return the treeitem of the added module
*/
WQtModuleTreeItem* addModuleItem( boost::shared_ptr< WModule > module );
......
......@@ -73,6 +73,8 @@ public:
/**
* helper function to add a generic button
* \param label Text on the push button
*
* \return the push button instance
*/
QPushButton* addPushButton( QString label );
......@@ -180,7 +182,9 @@ public:
void addSpacer();
/**
* getter for m_name
* The property group name.
*
* \return the group name
*/
QString getName();
......
......@@ -51,6 +51,8 @@ public:
/**
* add a dataset item below this subject in the tree
* \param module the module that has the dataset as output
*
* \return the tree item representing the module
*/
WQtDatasetTreeItem* addDatasetItem( boost::shared_ptr< WModule > module );
......
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