From 062c127b86316e02f7a19de3d90ccfbd285f6902 Mon Sep 17 00:00:00 2001 From: v4hn Date: Tue, 15 Jun 2021 09:49:05 +0200 Subject: [PATCH] better API comments for StageCallback --- core/include/moveit/task_constructor/container.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/include/moveit/task_constructor/container.h b/core/include/moveit/task_constructor/container.h index 27089356..fab732a7 100644 --- a/core/include/moveit/task_constructor/container.h +++ b/core/include/moveit/task_constructor/container.h @@ -55,7 +55,8 @@ public: Stage* findChild(const std::string& name) const; /** 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; /// traverse direct children of this container, calling the callback for each of them bool traverseChildren(const StageCallback& processor) const;