Commit d5a0a4b5 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC] added documentation and removed useless emtyp constructor and

destructor
parent 78cf84ae
......@@ -24,14 +24,6 @@
#include "WCrosshair.h"
WCrosshair::WCrosshair()
{
}
WCrosshair::~WCrosshair()
{
}
wmath::WPosition WCrosshair::getPosition()
{
return m_position;
......
......@@ -29,36 +29,29 @@
#include "../common/math/WVector3D.h"
/**
* TODO(schurade): Document this!
* This class stores the position of the crossing navigation slices,
* which is also represented as crosshairs in the navigation widgets.
* It can be used for placing things. An example are the ROIBoxes which
* are placed at the crosshairs position at the moment I am writing this.
*/
class WCrosshair
{
public:
/**
* TODO(schurade): Document this!
*/
WCrosshair();
/**
* TODO(schurade): Document this!
*/
~WCrosshair();
/**
* getter
* Get the position of the corsshair.
*/
wmath::WPosition getPosition();
/**
* setter
* Set the position of the crosshair for updating it.
*
* \param position
* \param position The new position.
*/
void setPosition( wmath::WPosition position );
protected:
private:
wmath::WPosition m_position; //!< stores the position
wmath::WPosition m_position; //!< Stores the current position of the crosshair.
};
#endif // WCROSSHAIR_H
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