fix comments

facontidavide · facontidavide · commit 0c1b92bcf37c · 2023-05-19T10:38:43.000+02:00
diff --git a/include/behaviortree_cpp/blackboard.h b/include/behaviortree_cpp/blackboard.h
@@ -255,7 +255,7 @@ class Blackboard
     storage_.clear();
   }
 
-  [[deprecated("Use getAnyRead or getAnyWrite to access safely an Entry")]]
+  [[deprecated("Use getAnyLocked to access safely an Entry")]]
   std::recursive_mutex& entryMutex() const
   {
     return entry_mutex_;
diff --git a/include/behaviortree_cpp/tree_node.h b/include/behaviortree_cpp/tree_node.h
@@ -261,13 +261,13 @@ class TreeNode
    *      // modifying the content of foo_ptr inside this scope IS thread-safe
    *    }
    *
-   * It is important to destroy the object AnyWriteRef, to release the lock.
+   * It is important to destroy the object AnyPtrLocked, to release the lock.
    *
    * NOTE: this method doesn't work, if the port contains a static string, instead
    * of a blackboard pointer.
    *
    * @param key  the identifier of the port.
-   * @return     empty AnyWriteRef if the blackboard entry doesn't exist or the content
+   * @return     empty AnyPtrLocked if the blackboard entry doesn't exist or the content
    *             of the port was a static string.
    */
   [[nodiscard]] AnyPtrLocked getLockedPortContent(const std::string& key);

Original file line number	Diff line number	Diff line change
`@@ -255,7 +255,7 @@ class Blackboard`
`255`	`255`	`storage_.clear();`
`256`	`256`	`}`
`257`	`257`
`258`		`- [[deprecated("Use getAnyRead or getAnyWrite to access safely an Entry")]]`
	`258`	`+ [[deprecated("Use getAnyLocked to access safely an Entry")]]`
`259`	`259`	`std::recursive_mutex& entryMutex() const`
`260`	`260`	`{`
`261`	`261`	`return entry_mutex_;`
Original file line number	Diff line number	Diff line change
`@@ -261,13 +261,13 @@ class TreeNode`
`261`	`261`	`* // modifying the content of foo_ptr inside this scope IS thread-safe`
`262`	`262`	`* }`
`263`	`263`	`*`
`264`		`- * It is important to destroy the object AnyWriteRef, to release the lock.`
	`264`	`+ * It is important to destroy the object AnyPtrLocked, to release the lock.`
`265`	`265`	`*`
`266`	`266`	`* NOTE: this method doesn't work, if the port contains a static string, instead`
`267`	`267`	`* of a blackboard pointer.`
`268`	`268`	`*`
`269`	`269`	`* @param key the identifier of the port.`
`270`		`- * @return empty AnyWriteRef if the blackboard entry doesn't exist or the content`
	`270`	`+ * @return empty AnyPtrLocked if the blackboard entry doesn't exist or the content`
`271`	`271`	`* of the port was a static string.`
`272`	`272`	`*/`
`273`	`273`	`[[nodiscard]] AnyPtrLocked getLockedPortContent(const std::string& key);`