Fix some doxygen comments

pull/122/head
D.R.racer 2021-09-29 12:24:48 +02:00 committed by DRracer
parent 1402fb3dd6
commit 1a5cd52d58
7 changed files with 8 additions and 5 deletions

View File

@ -9,7 +9,6 @@ namespace hal {
/// TMC2130 interface /// TMC2130 interface
/// There are multiple TMC2130 on our board, so there will be multiple /// There are multiple TMC2130 on our board, so there will be multiple
/// instances of this class /// instances of this class
/// @@TODO @leptun - design some lightweight TMC2130 interface
namespace tmc2130 { namespace tmc2130 {
enum MotorMode : uint8_t { enum MotorMode : uint8_t {

View File

@ -1,3 +1,4 @@
/// @file error_codes.h
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file progress_codes.h
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>

View File

@ -1,3 +1,4 @@
/// @file main.cpp
#include "hal/cpu.h" #include "hal/cpu.h"
#include "hal/adc.h" #include "hal/adc.h"
#include "hal/gpio.h" #include "hal/gpio.h"

View File

@ -20,11 +20,11 @@ public:
/// Plan engaging of the idler to a specific filament slot /// Plan engaging of the idler to a specific filament slot
/// @param slot index to be activated /// @param slot index to be activated
/// @returns #EngageDisengage /// @returns #OperationResult
OperationResult Engage(uint8_t slot); OperationResult Engage(uint8_t slot);
/// Plan disengaging of the idler, i.e. parking the idler /// Plan disengaging of the idler, i.e. parking the idler
/// @returns #EngageDisengage /// @returns #OperationResult
OperationResult Disengage(); OperationResult Disengage();
/// Plan homing of the idler axis /// Plan homing of the idler axis

View File

@ -201,7 +201,8 @@ public:
/// Set acceleration for the selected axis, but using physical units. The Axis needs to /// Set acceleration for the selected axis, but using physical units. The Axis needs to
/// be supplied as the first template argument: SetAcceleration<axis>(accel). /// be supplied as the first template argument: SetAcceleration<axis>(accel).
/// @param axis axis affected /// @tparam A axis affected
/// @tparam B unit base for the axis
/// @param accel acceleration /// @param accel acceleration
template <Axis A, config::UnitBase B> template <Axis A, config::UnitBase B>
void SetAcceleration(config::Unit<long double, B, Accel> accel) { void SetAcceleration(config::Unit<long double, B, Accel> accel) {

View File

@ -6,7 +6,7 @@
namespace modules { namespace modules {
namespace motion { 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 { class MovableBase {
public: public:
/// Internal states of the state machine /// Internal states of the state machine