diff --git a/src/hal/tmc2130.h b/src/hal/tmc2130.h index 6c29536..a88b058 100644 --- a/src/hal/tmc2130.h +++ b/src/hal/tmc2130.h @@ -9,7 +9,6 @@ namespace hal { /// TMC2130 interface /// There are multiple TMC2130 on our board, so there will be multiple /// instances of this class -/// @@TODO @leptun - design some lightweight TMC2130 interface namespace tmc2130 { enum MotorMode : uint8_t { diff --git a/src/logic/error_codes.h b/src/logic/error_codes.h index c02cc06..a565500 100644 --- a/src/logic/error_codes.h +++ b/src/logic/error_codes.h @@ -1,3 +1,4 @@ +/// @file error_codes.h #pragma once #include diff --git a/src/logic/progress_codes.h b/src/logic/progress_codes.h index 31a5f2b..1904549 100644 --- a/src/logic/progress_codes.h +++ b/src/logic/progress_codes.h @@ -1,3 +1,4 @@ +/// @file progress_codes.h #pragma once #include diff --git a/src/main.cpp b/src/main.cpp index fd83f2f..63f0244 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,3 +1,4 @@ +/// @file main.cpp #include "hal/cpu.h" #include "hal/adc.h" #include "hal/gpio.h" diff --git a/src/modules/idler.h b/src/modules/idler.h index 130632c..fa3072a 100644 --- a/src/modules/idler.h +++ b/src/modules/idler.h @@ -20,11 +20,11 @@ public: /// Plan engaging of the idler to a specific filament slot /// @param slot index to be activated - /// @returns #EngageDisengage + /// @returns #OperationResult OperationResult Engage(uint8_t slot); /// Plan disengaging of the idler, i.e. parking the idler - /// @returns #EngageDisengage + /// @returns #OperationResult OperationResult Disengage(); /// Plan homing of the idler axis diff --git a/src/modules/motion.h b/src/modules/motion.h index 3e44195..396a027 100644 --- a/src/modules/motion.h +++ b/src/modules/motion.h @@ -201,7 +201,8 @@ public: /// Set acceleration for the selected axis, but using physical units. The Axis needs to /// be supplied as the first template argument: SetAcceleration(accel). - /// @param axis axis affected + /// @tparam A axis affected + /// @tparam B unit base for the axis /// @param accel acceleration template void SetAcceleration(config::Unit accel) { diff --git a/src/modules/movable_base.h b/src/modules/movable_base.h index 950d070..7af751d 100644 --- a/src/modules/movable_base.h +++ b/src/modules/movable_base.h @@ -6,7 +6,7 @@ namespace modules { namespace motion { -/// Base class for movable modules - #Idler and #Selector contains the common code +/// Base class for movable modules - #modules::idler::Idler and #modules::selector::Selector contains the common code class MovableBase { public: /// Internal states of the state machine