From f4b0eb17433145469773ef2c29d4ea23bc8f41a6 Mon Sep 17 00:00:00 2001 From: Pascal Serrarens Date: Tue, 5 Dec 2023 11:15:15 +0100 Subject: [PATCH] Updated Motor documentation --- Motor.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Motor.h b/Motor.h index 8403875..5506678 100644 --- a/Motor.h +++ b/Motor.h @@ -6,10 +6,12 @@ namespace Passer { namespace RoboidControl { +/// @brief A Motor is a Thing which can move parts of the Roboid +/// @note Currently only rotational motors are supported class Motor : public Thing { public: + /// @brief Default constructor for the Motor Motor(); - /// @brief Turning direction of the motor /// @brief Motor turning direction enum class Direction { Clockwise = 1, CounterClockwise = -1 };