From 35ec36eb170bb5801c17f03637e2a9b97f13ded7 Mon Sep 17 00:00:00 2001 From: Ivan Santiago Paunovic Date: Thu, 26 Mar 2020 16:39:23 -0300 Subject: [PATCH] Address more reviewers' comments Signed-off-by: Ivan Santiago Paunovic --- rcl/include/rcl/graph.h | 2 +- rcl/include/rcl/security.h | 5 +++-- rcl/include/rcl/validate_security_context_name.h | 6 +++--- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/rcl/include/rcl/graph.h b/rcl/include/rcl/graph.h index a99af360d3..b0d65c4e00 100644 --- a/rcl/include/rcl/graph.h +++ b/rcl/include/rcl/graph.h @@ -453,7 +453,7 @@ rcl_get_node_names( * Thread-Safe | No * Uses Atomics | No * Lock-Free | Maybe [1] - * [1] implementation may need to protect the data structure with a lock + * [1] RMW implementation in use may need to protect the data structure with a lock * * \param[in] node the handle to the node being used to query the ROS graph * \param[in] allocator used to control allocation and deallocation of names diff --git a/rcl/include/rcl/security.h b/rcl/include/rcl/security.h index f729c1e25d..ac570d2c04 100644 --- a/rcl/include/rcl/security.h +++ b/rcl/include/rcl/security.h @@ -104,8 +104,9 @@ rcl_get_enforcement_policy(rmw_security_enforcement_policy_t * policy); * However, this expansion can be overridden by setting the secure directory override environment * (`ROS_SECURITY_DIRECTORY_OVERRIDE`) variable, allowing users to explicitly specify the exact secure * root directory to be utilized. - * Such an override is useful for where the security context is non-deterministic before runtime, - * or when testing and using additional tools that may not otherwise be easily provisioned. + * Such an override is useful for applications where the security context is non-deterministic + * before runtime, or when testing and using additional tools that may not otherwise be easily + * provisioned. * * \param[in] name validated name (a single token) * \param[in] allocator the allocator to use for allocation diff --git a/rcl/include/rcl/validate_security_context_name.h b/rcl/include/rcl/validate_security_context_name.h index 7b877b6fcd..935baba979 100644 --- a/rcl/include/rcl/validate_security_context_name.h +++ b/rcl/include/rcl/validate_security_context_name.h @@ -64,10 +64,10 @@ rcl_validate_security_context_name( /// Deterimine if a given security context name is valid. /** - * This is an overload with an extra parameter for the length of security_context. - * \param[in] security_context The number of characters in security_context. + * \sa This is an overload of \ref rcl_validate_security_context_name with an extra parameter + * for the length of security_context. * - * \sa rcl_validate_security_context(const char *, int *, size_t *) + * \param[in] security_context The number of characters in security_context. */ RCL_PUBLIC RCL_WARN_UNUSED