Skip to content

Commit fe40059

Browse files
committed
Fixed wording
Signed-off-by: ahcorde <[email protected]>
1 parent 5cdf0f4 commit fe40059

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

rosidl_runtime_c/include/rosidl_runtime_c/string_functions.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ extern "C"
3434
* All strings must be null-terminated.
3535
* The rosidl_runtime_c__String structure should be deallocated using the given function
3636
* rosidl_runtime_c__String__fini() when it is no longer needed.
37-
* Call this function with an already initialized string will leak memory.
37+
* Calling this function with an already initialized U16 string sequence structure will leak
38+
* memory.
3839
*
3940
* \param[inout] str a pointer to a rosidl_runtime_c__String structure
4041
* \return true if successful, false if the passed string pointer is null
@@ -92,7 +93,8 @@ rosidl_runtime_c__String__assign(
9293
* The rosidl_runtime_c__String__Sequence is initialized with the size passed to the function.
9394
* The rosidl_runtime_c__String__Sequence structure should be deallocated using the given function
9495
* rosidl_runtime_c__String__Sequence__fini() when it is no longer needed.
95-
* Call this function with an already initialized string sequence will leak memory.
96+
* Calling this function with an already initialized U16 string sequence structure will leak
97+
* memory.
9698
*
9799
* \param[inout] sequence a pointer to a string sequence
98100
* \param[in] size represents the size of the string sequence

rosidl_runtime_c/include/rosidl_runtime_c/u16string_functions.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ extern "C"
3333
* All strings must be null-terminated.
3434
* The rosidl_runtime_c__U16String structure should be deallocated using the given function
3535
* rosidl_runtime_c__U16String__fini() when it is no longer needed.
36-
* Call this function with an already initialized U16 string will leak memory.
36+
* Calling this function with an already initialized U16 string sequence structure will leak
37+
* memory.
3738
*
3839
* \param[inout] str a pointer to a U16 string structure
3940
* \return true if successful, false if the passed string pointer is null
@@ -139,7 +140,8 @@ rosidl_runtime_c__U16String__resize(
139140
* The rosidl_runtime_c__U16String__Sequence is initialized to the size passed to the function.
140141
* The U16 string sequence structure should be deallocated using the given
141142
* function rosidl_runtime_c__U16String__Sequence__fini() when it is no longer needed.
142-
* Call this function with an already initialized U16 string sequence structure will leak memory.
143+
* Calling this function with an already initialized U16 string sequence structure will leak
144+
* memory.
143145
*
144146
* \param[inout] sequence a pointer to a U16 string sequence structure
145147
* \param[in] size represents the size of the U16 string

0 commit comments

Comments
 (0)