Commit fd26c273 authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] reached less than 100 doxygen warings

parent 65c63b02
......@@ -88,7 +88,7 @@ public:
unsigned int getNumberOfDataSets() const;
protected:
private:
WPersonalInformation m_personalInfo;
WPersonalInformation m_personalInfo; //<! Information on the person represented by this WSubject.
/**
* A container for all WDataSets belonging to the subject.
......
......@@ -53,14 +53,20 @@ public:
void setName( QString name );
private:
QString m_name;
QString m_name; //!< Name of the check box.
public slots:
/**
* This function emits checkBoxStateChanged signal.
*/
void emitStateChanged();
signals:
/**
* Signal indicating that the state of the check box has changed.
* \param name name of the check box
* \param value Indicated whether the box is checked or not.
*/
void checkBoxStateChanged( QString name, bool value );
};
......
......@@ -39,6 +39,7 @@ class WQtNumberEdit : public QLineEdit
public:
/**
* default constructor
* \param parent The parent widget of this widget, i.e. the widget that manages it.
*/
explicit WQtNumberEdit( QWidget* parent = 0 );
......@@ -48,7 +49,12 @@ public:
virtual ~WQtNumberEdit();
public slots:
/**
* Set the value of the number edit.
* \param number the new number of the number edit.
*/
void setInt( int number );
void numberChanged();
signals:
......
......@@ -41,6 +41,8 @@ class WQtSliderWithEdit : public QWidget
public:
/**
* default constructor
* \param name Name of this GUI element.
* \param parent the widget that is the parent of this widget and thus manages it.
*/
explicit WQtSliderWithEdit( QString name, QWidget* parent = 0 );
......@@ -51,21 +53,25 @@ public:
/**
* setter for name
* \param name the new name for the GUI element.wo bin ich? hilfe! ich will hier raus
*/
void setName( QString name );
/**
* setter for min value
* \param min the new minimum value
*/
void setMin( int min );
/**
* setter for max value
* \param max the new maximum value
*/
void setMax( int max );
/**
* setter for current value
* \param value the new current value
*/
void setValue( int value );
......@@ -78,11 +84,11 @@ public slots:
protected:
private:
QSlider m_slider;
WQtNumberEdit m_edit;
QHBoxLayout m_layout;
QSlider m_slider; //!< The slider of this GUI element;
WQtNumberEdit m_edit; //!< The number field of the this GUI element.
QHBoxLayout m_layout; //!< The layout organizing the positioning of the edit and the slider.
QString m_name;
QString m_name; //!< The name of this gui element.
signals:
void signalNumberWithName( QString name, int number );
......
......@@ -37,8 +37,10 @@ class WQtPushButton : public QPushButton
Q_OBJECT
public:
/**
/**
* standard constructor
* \param icon The icon being displayed on the button.
* \param label The optional label that will be displayed besides the icon.
*/
explicit WQtPushButton( QIcon icon, QString label );
......@@ -49,6 +51,7 @@ public:
/**
* setter for name
* \param name The new name of the button
*/
void setName( QString name );
......@@ -61,9 +64,7 @@ public:
private:
QString m_name;
QString m_name; //!< name of the push button
public slots:
void emitPressed();
......
......@@ -63,6 +63,9 @@ public:
*/
std::vector< QString > getButtons();
/**
* Returns the name of the tab
*/
QString getName();
/**
......@@ -80,9 +83,9 @@ protected:
bool m_persistent;
private:
QHBoxLayout* m_pageLayout;
QHBoxLayout* m_pageLayout; //!< Organizes the layout of the tab horizontally.
QString m_name;
QString m_name; //!< Name of the tab.
/**
* List of buttons belonging to this tab.
......
......@@ -40,6 +40,7 @@ class WQtRibbonMenu : public QToolBar
public:
/**
* default constructor
* \param parent the parent widget of this widget, i.e. the widget that manages it.
*/
explicit WQtRibbonMenu( QWidget* parent );
......@@ -49,17 +50,24 @@ public:
virtual ~WQtRibbonMenu();
/**
*
* Adds a new tab to the ribbon menu and gives it a name.
* \param name The name of the tab.
* \param persistent Determines whether the new will be removed when removing non-persistent tabs.
*/
WQtMenuPage* addTab( QString name, bool persistent = true );
/**
*
* Adds a push button to the menu. The button is identifiable by its name.
* \param name a name for the new button to identifie it
* \param tabName the name of the tab to which the button is added.
* \param icon and icon for the button
* \param label The optional text that is displayed besides the icon on the button.
*/
WQtPushButton* addPushButton( QString name, QString tabName, QIcon icon, QString label = 0 );
/**
*
* Get a button by its name.
* \param name The name that identifies the button.
*/
WQtPushButton* getButton( QString name );
......@@ -69,11 +77,11 @@ public:
void clearNonPersistentTabs();
protected:
private:
std::map< QString, WQtMenuPage*>m_tabList;
std::map< QString, WQtMenuPage*> m_tabList;
std::map< QString, WQtPushButton*>m_buttonList;
std::map< QString, WQtPushButton*> m_buttonList;
QTabWidget* m_tabWidget;
QTabWidget* m_tabWidget; //!< The tab widget beeing the basis for the ribbon menu.
};
#endif // WQTRIBBONMENU_H
......@@ -29,6 +29,9 @@
#include "../WGUI.h"
/**
* Tests for WGUI: Since WGUI is abstrac no test are here to define
*/
class WGUITest : public CxxTest::TestSuite
{
public:
......
......@@ -30,13 +30,13 @@
#include "../WMDistanceMap.h"
/**
* TODO(wiebel): Document this!
* Tests for Module "Distance Map"
*/
class WMDistanceMapTest : public CxxTest::TestSuite
{
public:
/**
* TODO(wiebel): Document this!
* TODO(wiebel):implement some tests and document them
*/
void testSomething( void )
{
......
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