Skip to content

Commit be5b5f2

Browse files
committed
Doc for rcl_arguments_get_param_files_count()
1 parent 4592e3e commit be5b5f2

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

rcl/include/rcl/arguments.h

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,20 @@ rcl_arguments_get_unparsed(
137137
rcl_allocator_t allocator,
138138
int ** output_unparsed_indices);
139139

140-
140+
/// Return the number of parameter yaml files given in the arguments.
141+
/**
142+
* <hr>
143+
* Attribute | Adherence
144+
* ------------------ | -------------
145+
* Allocates Memory | No
146+
* Thread-Safe | No
147+
* Uses Atomics | No
148+
* Lock-Free | Yes
149+
*
150+
* \param[in] args An arguments structure that has been parsed.
151+
* \return number of yaml files, or
152+
* \return -1 if args is `NULL` or zero initialized.
153+
*/
141154
RCL_PUBLIC
142155
RCL_WARN_UNUSED
143156
int

0 commit comments

Comments
 (0)