PulseGen: improve comments.

pull/47/head
Yuri D'Elia 2021-07-13 15:10:47 +02:00
parent fcb1b0c85d
commit c7459df05e
1 changed files with 2 additions and 1 deletions

View File

@ -14,6 +14,7 @@ using hal::tmc2130::TMC2130;
using math::mulU24X24toH16; using math::mulU24X24toH16;
using speed_table::calc_timer; using speed_table::calc_timer;
using speed_table::st_timer_t; using speed_table::st_timer_t;
typedef CircularIndex<uint8_t, blockBufferSize> circular_index_t; typedef CircularIndex<uint8_t, blockBufferSize> circular_index_t;
typedef uint32_t steps_t; ///< Absolute step units typedef uint32_t steps_t; ///< Absolute step units
typedef uint32_t rate_t; ///< Type for step rates typedef uint32_t rate_t; ///< Type for step rates
@ -39,7 +40,7 @@ public:
/// Stop whatever moves are being done /// Stop whatever moves are being done
void AbortPlannedMoves(); void AbortPlannedMoves();
/// @returns the position of the axis at the end of all moves /// @returns the head position of the axis at the end of all moves
pos_t Position() const { return position; } pos_t Position() const { return position; }
/// Fetch the current position of the axis while stepping. This function is expensive! /// Fetch the current position of the axis while stepping. This function is expensive!