From c7459df05e5ddfb7f3d52bb985bcf6b42c06bae1 Mon Sep 17 00:00:00 2001 From: Yuri D'Elia Date: Tue, 13 Jul 2021 15:10:47 +0200 Subject: [PATCH] PulseGen: improve comments. --- src/modules/pulse_gen.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/modules/pulse_gen.h b/src/modules/pulse_gen.h index 37554f1..85c88f3 100644 --- a/src/modules/pulse_gen.h +++ b/src/modules/pulse_gen.h @@ -14,6 +14,7 @@ using hal::tmc2130::TMC2130; using math::mulU24X24toH16; using speed_table::calc_timer; using speed_table::st_timer_t; + typedef CircularIndex circular_index_t; typedef uint32_t steps_t; ///< Absolute step units typedef uint32_t rate_t; ///< Type for step rates @@ -39,7 +40,7 @@ public: /// Stop whatever moves are being done 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; } /// Fetch the current position of the axis while stepping. This function is expensive!