Updated Motor documentation
This commit is contained in:
parent
f33b02311c
commit
f4b0eb1743
4
Motor.h
4
Motor.h
@ -6,10 +6,12 @@
|
|||||||
namespace Passer {
|
namespace Passer {
|
||||||
namespace RoboidControl {
|
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 {
|
class Motor : public Thing {
|
||||||
public:
|
public:
|
||||||
|
/// @brief Default constructor for the Motor
|
||||||
Motor();
|
Motor();
|
||||||
/// @brief Turning direction of the motor
|
|
||||||
|
|
||||||
/// @brief Motor turning direction
|
/// @brief Motor turning direction
|
||||||
enum class Direction { Clockwise = 1, CounterClockwise = -1 };
|
enum class Direction { Clockwise = 1, CounterClockwise = -1 };
|
||||||
|
Loading…
x
Reference in New Issue
Block a user