mirror of
https://github.com/moveit/moveit_task_constructor.git
synced 2025-11-04 14:49:57 +08:00
better API comments for StageCallback
This commit is contained in:
parent
64b65e4eca
commit
062c127b86
@ -55,7 +55,8 @@ public:
|
|||||||
Stage* findChild(const std::string& name) const;
|
Stage* findChild(const std::string& name) const;
|
||||||
|
|
||||||
/** Callback function type used by traverse functions
|
/** Callback function type used by traverse functions
|
||||||
* The callback should return false if traversal should be stopped. */
|
* Receives currently visited Stage and current depth in hierarchy
|
||||||
|
* If callback returns false, traversal is stopped. */
|
||||||
using StageCallback = std::function<bool(const Stage&, unsigned int)>;
|
using StageCallback = std::function<bool(const Stage&, unsigned int)>;
|
||||||
/// traverse direct children of this container, calling the callback for each of them
|
/// traverse direct children of this container, calling the callback for each of them
|
||||||
bool traverseChildren(const StageCallback& processor) const;
|
bool traverseChildren(const StageCallback& processor) const;
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user