Added a bit of documentation

This commit is contained in:
Pascal Serrarens 2023-11-23 16:52:21 +01:00
parent ff7ad8d3df
commit 438d8ba941
3 changed files with 17 additions and 4 deletions

View File

@ -2,6 +2,7 @@
#include "Thing.h"
/// @brief A sensor is a thing which can perform measurements in the environment
class Sensor : public Thing {
public:
Sensor();

View File

@ -1,8 +1,9 @@
#pragma once
/// @brief A thing is a functional component on a robot
class Thing {
public:
Thing() { isSensor = false, isMotor = false; }
bool isSensor;
bool isMotor;
public:
Thing() { isSensor = false, isMotor = false; }
bool isSensor;
bool isMotor;
};

11
library.json Normal file
View File

@ -0,0 +1,11 @@
{
"name": "RoboidControl",
"version": "0.0",
"build": {
"srcDir": ".",
"flags": [
"-I .",
"-I ./VectorAlgebra/include"
]
}
}