doc update

This commit is contained in:
Tristan Krause 2019-05-23 15:08:54 +02:00
parent 90e62b739b
commit 5f48849c4e
117 changed files with 3780 additions and 2135 deletions

View file

@ -4,17 +4,37 @@
#include <cstdint>
#include <stdexcept>
/**
* Immutable dot class with x and y coordinate and curve index.
* Dots with the same curve index get the same color by plotty.
*/
class Dot
{
public:
Dot(uint16_t x, uint16_t y, uint8_t curve);
uint16_t getX(void) const;
uint16_t getY(void) const;
uint8_t getCurve(void) const;
/**
* Constructor with x and y coordinate and curve index.
*/
Dot(uint16_t x, uint16_t y, uint8_t curve);
/**
* Returns the x coordinate.
*/
uint16_t getX(void) const;
/**
* Returns the y coordinate.
*/
uint16_t getY(void) const;
/**
* Returns the curve index.
*/
uint8_t getCurve(void) const;
private:
uint16_t x, y;
uint8_t curve;
uint16_t x, y;
uint8_t curve;
};