Skip to content

Commit 9ac0f8d

Browse files
committed
Doc fixup
1 parent 0cf31b5 commit 9ac0f8d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

rcl/src/rcl/arguments.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ static rcl_arguments_t __rcl_global_arguments;
3939
/// Parse an argument that may or may not be a remap rule.
4040
/// \param[in] arg the argument to parse
4141
/// \param[in] allocator an allocator to use
42-
/// \param[in,out] log_level parsed log level represented by RCUTILS_LOG_SEVERITY enum
43-
/// \return RCL_RET_OK if a valid log level was parsed, or
42+
/// \param[in,out] output_rule input a zero intialized rule, output a fully initialized one
43+
/// \return RCL_RET_OK if a valid rule was parsed, or
4444
/// \return RCL_RET_INVALID_REMAP_RULE if the argument is not a valid rule, or
4545
/// \return RCL_RET_BAD_ALLOC if an allocation failed, or
4646
/// \return RLC_RET_ERROR if an unspecified error occurred.
@@ -109,10 +109,10 @@ rcl_arguments_get_param_files_count(
109109
return args->impl->num_param_files_args;
110110
}
111111

112-
/// Parse an argument that may or may not be a remap rule.
112+
/// Parse an argument that may or may not be a log level rule.
113113
/// \param[in] arg the argument to parse
114114
/// \param[in] allocator an allocator to use
115-
/// \param[in,out] log_level parsed log level represented by RCUTILS_LOG_SEVERITY enum
115+
/// \param[in,out] log_level parsed log level represented by `RCUTILS_LOG_SEVERITY` enum
116116
/// \return RCL_RET_OK if a valid log level was parsed, or
117117
/// \return RCL_RET_INVALID_LOG_LEVEL_RULE if the argument is not a valid rule, or
118118
/// \return RCL_RET_BAD_ALLOC if an allocation failed, or

0 commit comments

Comments
 (0)