Skip to content

Commit

Permalink
Improved comments describing interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
lromor committed Apr 29, 2023
1 parent 846dfb8 commit 17baad1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions src/motion-queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,9 @@ class MotionQueue {
// of not yet executed loops in the item currenly being executed.
virtual int GetPendingElements(uint32_t *head_item_progress) = 0;

// Perform an immediate reset of the queue,
// even if motors are still moving.
// Immediately stop any motion and clear the internal queue.
// Returns true if the queue was successfully cleared,
// false if an internal error occurred.
virtual bool Clear() = 0;
};

Expand Down
6 changes: 3 additions & 3 deletions src/segment-queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ class SegmentQueue {
// PhysicalStatus.
virtual void SetExternalPosition(int axis, int position_steps) = 0;

// Clear the queue and reset it to its initial state.
// This action is immediate and will discard any running or
// enqueued and not yet executed segment.
// Immediately stop any motion and clear the internal queue.
// Current physical status will be lost.
// Returns true if the queue was successfully cleared,
// false if an internal error occurred.
virtual bool Clear() = 0;
};

Expand Down

0 comments on commit 17baad1

Please sign in to comment.