document the Point class
This commit is contained in:
parent
5dc5cc32b0
commit
8693dd95a2
1 changed files with 12 additions and 1 deletions
13
otk/point.hh
13
otk/point.hh
|
@ -3,22 +3,33 @@
|
|||
#define __point_hh
|
||||
|
||||
/*! @file point.hh
|
||||
@brief The Point class contains an x/y pair
|
||||
*/
|
||||
|
||||
namespace otk {
|
||||
|
||||
//! The Point class is an x/y coordinate or size pair
|
||||
class Point {
|
||||
private:
|
||||
int _x, _y;
|
||||
//! The x value
|
||||
int _x;
|
||||
//! The y value
|
||||
int _y;
|
||||
|
||||
public:
|
||||
//! Constructs a new Point with 0,0 values
|
||||
Point() : _x(0), _y(0) {}
|
||||
//! Constructs a new Point with given values
|
||||
Point(int x, int y) : _x(x), _y(y) {}
|
||||
|
||||
//! Changes the x value to the new value specified
|
||||
void setX(int x) { _x = x; }
|
||||
//! Returns the x value
|
||||
void x() const { return _x; }
|
||||
|
||||
//! Changes the y value to the new value specified
|
||||
void setY(int x) { _x = x; }
|
||||
//! Returns the y value
|
||||
void y() const { return _x; }
|
||||
};
|
||||
|
||||
|
|
Loading…
Reference in a new issue