niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc fixups (#288)

Browse source 
* remove vestigial parameter documentation

* fix parameter name typo

* small fixup
This commit is contained in:
William Woodall 2018-08-31 18:32:27 -07:00 • committed by GitHub
parent 955c0c93da
commit 7289d4a00a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 2 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
rcl/include/rcl/arguments.h
View file

@ -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.

2
rcl/include/rcl/remap.h
View file

@ -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,

2
rcl_yaml_param_parser/include/rcl_yaml_param_parser/parser.h
View file

@ -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(