add comment for rcl_get_secure_root

Signed-off-by: Abby Xu <abbyxu@amazon.com>
ros2 · May 3, 2019 · 4639789 · 4639789
1 parent c0d0147
commit 4639789
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/rcl/include/rcl/security_directory.h b/rcl/include/rcl/security_directory.h
@@ -51,6 +51,7 @@ extern "C"
  * \param[in] node_namespace validated, absolute namespace (starting with "/")
  * \param[in] allocator the allocator to use for allocation
  * \returns machine specific (absolute) node secure root path or NULL on failure
+ *          returned pointer must be deallocated by the caller of this function
  */
 RCL_PUBLIC
 char * rcl_get_secure_root(