From 7289d4a00a45a12e70c70816e5b3ba7072c21d14 Mon Sep 17 00:00:00 2001 From: William Woodall Date: Fri, 31 Aug 2018 18:32:27 -0700 Subject: [PATCH] Doc fixups (#288) * remove vestigial parameter documentation * fix parameter name typo * small fixup --- rcl/include/rcl/arguments.h | 1 - rcl/include/rcl/remap.h | 2 +- rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/rcl/include/rcl/arguments.h b/rcl/include/rcl/arguments.h index 86d604c..8a83ea0 100644 --- a/rcl/include/rcl/arguments.h +++ b/rcl/include/rcl/arguments.h @@ -271,7 +271,6 @@ rcl_arguments_copy( * Lock-Free | Yes * * \param[in] args The structure to be deallocated. - * \param[in] allocator A valid allocator. * \return `RCL_RET_OK` if the memory was successfully freed, or * \return `RCL_RET_INVALID_ARGUMENT` if any function arguments are invalid, or * \return `RCL_RET_ERROR` if an unspecified error occurs. diff --git a/rcl/include/rcl/remap.h b/rcl/include/rcl/remap.h index 82f639d..edcb7d4 100644 --- a/rcl/include/rcl/remap.h +++ b/rcl/include/rcl/remap.h @@ -140,7 +140,7 @@ rcl_ret_t rcl_remap_service_name( const rcl_arguments_t * local_arguments, const rcl_arguments_t * global_arguments, - const char * serivice_name, + const char * service_name, const char * node_name, const char * node_namespace, rcl_allocator_t allocator, diff --git a/rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h b/rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h index c578947..9e7d1f2 100644 --- a/rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h +++ b/rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h @@ -40,7 +40,7 @@ void rcl_yaml_node_struct_fini( /// \brief Parse the YAML file, initialize and populate params_st /// \param[in] file_path is the path to the YAML file -/// \param[in/out] params_st points to the populated paramter struct +/// \param[inout] params_st points to the populated paramter struct /// \return true on success and false on failure RCL_YAML_PARAM_PARSER_PUBLIC bool rcl_parse_yaml_file(