From 438d8ba94100f1c00c7f4b3915d12e8402f89505 Mon Sep 17 00:00:00 2001 From: Pascal Serrarens Date: Thu, 23 Nov 2023 16:52:21 +0100 Subject: [PATCH] Added a bit of documentation --- Sensor.h | 1 + Thing.h | 9 +++++---- library.json | 11 +++++++++++ 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 library.json diff --git a/Sensor.h b/Sensor.h index f49bfe6..1f47259 100644 --- a/Sensor.h +++ b/Sensor.h @@ -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(); diff --git a/Thing.h b/Thing.h index 610542c..dc29ba0 100644 --- a/Thing.h +++ b/Thing.h @@ -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; }; \ No newline at end of file diff --git a/library.json b/library.json new file mode 100644 index 0000000..8b014b3 --- /dev/null +++ b/library.json @@ -0,0 +1,11 @@ +{ + "name": "RoboidControl", + "version": "0.0", + "build": { + "srcDir": ".", + "flags": [ + "-I .", + "-I ./VectorAlgebra/include" + ] + } +} \ No newline at end of file