Commit 164967f1 authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] documented some parameters. Less than 60 doxy errors now

parent a9a1039c
......@@ -50,7 +50,7 @@ public:
/**
* Creates a new log message.
*
*
* \param logTime the time
* \param message the message
* \param level the log level
......@@ -65,6 +65,7 @@ public:
virtual ~WLogEntry();
/**
* \param format A string describing the output format in c printf style
* \return String of this log entry.
*/
std::string getLogString( std::string format = "[%t] *%l* %m \n" );
......@@ -76,14 +77,14 @@ public:
/**
* Set whether to use colors or not. Note: this is only useful on Linux systems currently.
*
*
* \param colors true if colors should be used.
*/
void setColored( bool colors );
/**
* Getter determining whether to use colors or not.
*
*
* \return true if colors should be used.
*/
bool isColored();
......
......@@ -65,27 +65,32 @@ public:
/**
* Sets the global log level
* \param level the new global logging level
*/
void setLogLevel( LogLevel level );
/**
* Sets the log level for stdout.
* \param level the new logging level for stdout
*/
void setSTDOUTLevel( LogLevel level );
/**
* Sets the log level for stderr.
* \param level the new logging level for stderr
*/
void setSTDERRLevel( LogLevel level );
/**
* Sets the log level for the given log file.
* \param level the new level for logging to file
*/
void setLogFileLevel( LogLevel level );
/**
* Specifies the path for logging to this file and checks if the path
* exists by an assertion.
* \param fileName the name and path of the file to be used for logging.
*/
void setLogFileName( std::string fileName );
......@@ -133,6 +138,9 @@ public:
/**
* Appends a log message to the logging queue.
* \param message the log entry
* \param source indicates where this entry comes from
* \param level The logging level of the current message
*/
void addLogMessage( std::string message, std::string source = "", LogLevel level = LL_DEBUG );
......
......@@ -39,7 +39,7 @@
#ifdef __linux__
// This is highly platform dependent. Used for backtrace functionality.
/**
/**
* Template class for every signal which can be handled.
*/
template <class SignalExceptionClass> class SignalTranslator
......@@ -82,6 +82,7 @@ public:
/**
* Default constructor.
* \param msg name of the exception. mostly the default "Segmentation Fault"
*/
explicit WSegmentationFault( const std::string& msg = "Segmentation Fault" );
......@@ -90,14 +91,14 @@ public:
*/
virtual ~WSegmentationFault() throw();
/**
* Defines signal type to handle.
/**
* Defines signal type to handle.
* @return The signal number.
*/
static int getSignalNumber() throw();
/**
* Installs this exception as signal handler for SIGSEGV.
/**
* Installs this exception as signal handler for SIGSEGV.
* This will just work on Linux.
*/
static void installSignalHandler() throw();
......
......@@ -58,6 +58,7 @@ public:
/**
* Set the name of the file that this data set stems from.
* \param fileName the string representing the name
*/
void setFileName( const std::string fileName );
......
......@@ -70,8 +70,11 @@ protected:
std::string m_fileName; //!< Name of file to load.
boost::shared_ptr< WDataHandler > m_dataHandler; //!< Reference to DataHandler
void commitDataSet( boost::shared_ptr< WDataSet > data ); //!< Commit new data into the DataHandler.
/**
* Commit new data into the DataHandler.
* \param data This dataset will be added to the WDataHandler
*/
void commitDataSet( boost::shared_ptr< WDataSet > data );
private:
};
......
......@@ -63,7 +63,7 @@ public:
/**
* Sets the subjectID of the person. This must be non-zero as changed information is not considered dummy anymore.
* \param subjectId New globally unique identifier
* \param subjectID New globally unique identifier
*/
void setSubjectID( uint64_t subjectID );
......
......@@ -42,6 +42,7 @@ class WDHNoSuchDataSet : public WDHException
public:
/**
* Constructs new exception.
* \param msg the reason for this exception.
*/
explicit WDHNoSuchDataSet( const std::string& msg = "DataHandler Exception: Invalid DataSet Access" );
......
......@@ -38,17 +38,20 @@ class WIconManager
public:
/**
* function to add an Icon to the icon store
* \param name the icon's name
* \param xpm the icon itself in XPM format
*/
void addIcon( std::string name, const char* const xpm[] );
/**
* returns i previously stored icon
* returns a previously stored icon
* \param name name of the requested icon
*/
QIcon getIcon( const std::string name );
protected:
private:
std::map< std::string, QIcon* >m_iconList;
std::map< std::string, QIcon* >m_iconList; //!< A map storing icons and the names used to identify them
};
#endif // WICONMANAGER_H
......@@ -41,7 +41,10 @@ public:
/**
* default constructor
*
* \param parent the parent widget.
* \param title Title will be displayed above the widget
* \param parent The widget that manages this widget
* \param maxValue Maximum value for the corresponding nav slice slider
* \param sliderTitle Name of the slider corresponding to the property it manipulates
*/
explicit WQtNavGLWidget( QString title, QWidget* parent, int maxValue = 100, std::string sliderTitle="pos" );
......
......@@ -49,6 +49,7 @@ public:
/**
* setter for name
* \param name The new name of the check box
*/
void setName( QString name );
......
......@@ -49,7 +49,9 @@ class WQtDSBWidget : public QWidget
public:
/**
* default constructor
* Creates new data set browser widget
* \param name Name of the widget
* \param parent The widget managing this widget
*/
explicit WQtDSBWidget( std::string name, QWidget* parent = 0 );
......@@ -60,16 +62,21 @@ public:
/**
* helper function to add a generic button
* \param label Text on the push button
*/
QPushButton* addPushButton( QString label );
/**
* helper function to add a generic checkbox
* \param label The text next to the check box
* \param isChecked the initial state of the check box
*/
WQtCheckBox* addCheckBox( QString label, bool isChecked = false );
/**
* helper function to add a generic line edit
* \param label The text next to the line edit
* \param text The text intially in the line edit
*/
WQtLineEdit* addLineEdit( QString label, QString text = QString( "" ) );
......@@ -82,6 +89,10 @@ public:
/**
* helper function to add a slider with a connect line edit
* \param label The text next to the slider and the edit field
* \param value Initial value of slider and field
* \param min Minimum value for slider
* \param max Maximum value for slider
*/
WQtSliderWithEdit* addSliderInt( QString label, int value = 0, int min = 0, int max = 100 );
......
......@@ -36,6 +36,8 @@ class WQtDatasetTreeItem : public QTreeWidgetItem
public:
/**
* standard constructor
* \param parent The parent widget that manages this widget.
* \param module The module that will be represented by the item.
*/
explicit WQtDatasetTreeItem( QTreeWidgetItem * parent, boost::shared_ptr< WModule > module );
......@@ -51,7 +53,7 @@ public:
protected:
private:
boost::shared_ptr< WModule >m_module;
boost::shared_ptr< WModule > m_module; //!< The module represented by this item.
};
#endif // WQTDATASETTREEITEM_H
......@@ -49,6 +49,7 @@ public:
/**
* setter for name
* \param name the new name for the line edit
*/
void setName( QString name );
......
......@@ -39,6 +39,7 @@ class WQtModuleHeaderTreeItem : public QTreeWidgetItem
public:
/**
* TODO(schurade): Document this!
* \param parent The widget managing this widget.
*/
explicit WQtModuleHeaderTreeItem( QTreeWidget * parent );
......@@ -47,6 +48,10 @@ public:
*/
virtual ~WQtModuleHeaderTreeItem();
/**
* Add an module to the tree view.
* \param module The new module.
*/
WQtModuleTreeItem* addModuleItem( boost::shared_ptr< WModule > module );
protected:
......
......@@ -36,6 +36,8 @@ class WQtModuleTreeItem : public QTreeWidgetItem
public:
/**
* TODO(schurade): Document this!
* \param parent The widget managing this widget
* \param module The represented module
*/
WQtModuleTreeItem( QTreeWidgetItem * parent, boost::shared_ptr< WModule > module );
......
......@@ -39,11 +39,14 @@ class WQtNumberEditDouble : public QLineEdit
public:
/**
* Default constructor, that connects the slot of the edit
* \param name The name of teh widget
* \param parent The widget managing this widget
*/
explicit WQtNumberEditDouble( QString name, QWidget* parent = 0 );
/**
* setter for name
* \param name The new name for the widget
*/
void setName( QString name );
......
......@@ -39,6 +39,7 @@ class WQtSubjectTreeItem : public QTreeWidgetItem
public:
/**
* default constructor
* \param parent the parent widget of this item, i.e. the widget that manages this item
*/
explicit WQtSubjectTreeItem( QTreeWidget * parent );
......@@ -49,6 +50,7 @@ public:
/**
* add a dataset item below this subject in the tree
* \param module the module that has the dataset as output
*/
WQtDatasetTreeItem* addDatasetItem( boost::shared_ptr< WModule > module );
......
......@@ -37,6 +37,7 @@ class WQtTreeWidget : public QTreeWidget
public:
/**
* default constructor
* \param parent the parent widget of this widget, i.e. the widget that manages this widget
*/
explicit WQtTreeWidget( QWidget* parent = 0 );
......
......@@ -125,14 +125,16 @@ private:
void create();
/**
* initial creation function for the slice geometry
* Initial creation function for the slice geometry
* \param slice ID of the slice to be drawn. 0=y, 1=x, 2=z
*/
osg::ref_ptr<osg::Geometry> createGeometry( int slice );
/**
* creates and initializes the uniform parameters for the shader
* \param rootState The uniforms will be applied to this state.
*/
void initUniforms( osg::StateSet* sliceState );
void initUniforms( osg::StateSet* rootState );
/**
* the root node for this 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