Skip to content

Commit 7410ba2

Browse files
committed
update docs
Signed-off-by: Tony Najjar <[email protected]>
1 parent 57c7bfe commit 7410ba2

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

include/behaviortree_cpp/bt_factory.h

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,13 @@ class Tree
118118

119119
[[nodiscard]] TreeNode* rootNode() const;
120120

121-
/// Sleep for a certain amount of time.
122-
/// This sleep could be interrupted by the method
123-
/// TreeNode::emitWakeUpSignal()
121+
/**
122+
* @brief Sleep for a certain amount of time. This sleep could be interrupted by the method TreeNode::emitWakeUpSignal()
123+
*
124+
* @param timeout duration of the sleep
125+
* @return true if the timeout was NOT reached and the signal was received.
126+
*
127+
* */
124128
bool sleep(std::chrono::system_clock::duration timeout);
125129

126130
~Tree();

0 commit comments

Comments
 (0)