Skip to content

Commit fbce779

Browse files
github-actions[bot]Acuadros95
github-actions[bot]
and
Acuadros95
authored
micro-ROS Utils API reference auto-update 13-06-2023 12:21 (#409)
Co-authored-by: Acuadros95 <Acuadros95@users.noreply.github.com>
1 parent 89710b3 commit fbce779

File tree

2 files changed

+67
-67
lines changed

2 files changed

+67
-67
lines changed

‎_includes/utils_doc/Modules/group__stringutils.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_init](#function-micro_ros_string_utilities_init)**(const char * data)<br>Create a rosidl_runtime_c__String from a char pointer. |
88
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_init_with_size](#function-micro_ros_string_utilities_init_with_size)**(const size_t size)<br>Create a rosidl_runtime_c__String from a size. |
99
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_set](#function-micro_ros_string_utilities_set)**(const rosidl_runtime_c__String str, const char * data)<br>Create a rosidl_runtime_c__String from a char pointer. |
10-
| const MICRO_ROS_UTILITIES_PUBLIC char * | **[micro_ros_string_utilities_get_c_str](#function-micro_ros_string_utilities_get_c_str)**(const rosidl_runtime_c__String str)<br>Returns the char pointer to the rosidl_runtime_c__String data. |
10+
| MICRO_ROS_UTILITIES_PUBLIC const char * | **[micro_ros_string_utilities_get_c_str](#function-micro_ros_string_utilities_get_c_str)**(const rosidl_runtime_c__String str)<br>Returns the char pointer to the rosidl_runtime_c__String data. |
1111
| rosidl_runtime_c__String | **[micro_ros_string_utilities_append](#function-micro_ros_string_utilities_append)**(const rosidl_runtime_c__String str, const char * data)<br>Appends a char pointer to the end of a rosidl_runtime_c__String. |
1212
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_remove_tail_chars](#function-micro_ros_string_utilities_remove_tail_chars)**(const rosidl_runtime_c__String str, const size_t n)<br>Removes characters from the end of a string. |
1313
| MICRO_ROS_UTILITIES_PUBLIC void | **[micro_ros_string_utilities_destroy](#function-micro_ros_string_utilities_destroy)**(rosidl_runtime_c__String *const str)<br>Destroys a rosidl_runtime_c__String. |
@@ -36,12 +36,12 @@ Create a rosidl_runtime_c__String from a char pointer.
3636
------------------
3737

3838

39-
| Attribute | Adherence |
39+
| Attribute | Adherence |
4040
| -------- | -------- |
41-
| Allocates Memory | Yes |
42-
| Thread-Safe | No |
43-
| Uses Atomics | No |
44-
| Lock-Free | Yes |
41+
| Allocates Memory | Yes |
42+
| Thread-Safe | No |
43+
| Uses Atomics | No |
44+
| Lock-Free | Yes |
4545

4646

4747
### function micro_ros_string_utilities_init_with_size
@@ -66,12 +66,12 @@ Create a rosidl_runtime_c__String from a size.
6666
------------------
6767

6868

69-
| Attribute | Adherence |
69+
| Attribute | Adherence |
7070
| -------- | -------- |
71-
| Allocates Memory | Yes |
72-
| Thread-Safe | No |
73-
| Uses Atomics | No |
74-
| Lock-Free | Yes |
71+
| Allocates Memory | Yes |
72+
| Thread-Safe | No |
73+
| Uses Atomics | No |
74+
| Lock-Free | Yes |
7575

7676

7777
### function micro_ros_string_utilities_set
@@ -98,18 +98,18 @@ Create a rosidl_runtime_c__String from a char pointer.
9898
------------------
9999

100100

101-
| Attribute | Adherence |
101+
| Attribute | Adherence |
102102
| -------- | -------- |
103-
| Allocates Memory | Yes |
104-
| Thread-Safe | No |
105-
| Uses Atomics | No |
106-
| Lock-Free | Yes |
103+
| Allocates Memory | Yes |
104+
| Thread-Safe | No |
105+
| Uses Atomics | No |
106+
| Lock-Free | Yes |
107107

108108

109109
### function micro_ros_string_utilities_get_c_str
110110

111111
```cpp
112-
const MICRO_ROS_UTILITIES_PUBLIC char * micro_ros_string_utilities_get_c_str(
112+
MICRO_ROS_UTILITIES_PUBLIC const char * micro_ros_string_utilities_get_c_str(
113113
const rosidl_runtime_c__String str
114114
)
115115
```
@@ -128,12 +128,12 @@ Returns the char pointer to the rosidl_runtime_c__String data.
128128
------------------
129129

130130

131-
| Attribute | Adherence |
131+
| Attribute | Adherence |
132132
| -------- | -------- |
133-
| Allocates Memory | Yes |
134-
| Thread-Safe | No |
135-
| Uses Atomics | No |
136-
| Lock-Free | Yes |
133+
| Allocates Memory | Yes |
134+
| Thread-Safe | No |
135+
| Uses Atomics | No |
136+
| Lock-Free | Yes |
137137

138138

139139
### function micro_ros_string_utilities_append
@@ -160,12 +160,12 @@ Appends a char pointer to the end of a rosidl_runtime_c__String.
160160
------------------
161161

162162

163-
| Attribute | Adherence |
163+
| Attribute | Adherence |
164164
| -------- | -------- |
165-
| Allocates Memory | Yes |
166-
| Thread-Safe | No |
167-
| Uses Atomics | No |
168-
| Lock-Free | Yes |
165+
| Allocates Memory | Yes |
166+
| Thread-Safe | No |
167+
| Uses Atomics | No |
168+
| Lock-Free | Yes |
169169

170170

171171
### function micro_ros_string_utilities_remove_tail_chars
@@ -192,12 +192,12 @@ Removes characters from the end of a string.
192192
------------------
193193

194194

195-
| Attribute | Adherence |
195+
| Attribute | Adherence |
196196
| -------- | -------- |
197-
| Allocates Memory | Yes |
198-
| Thread-Safe | No |
199-
| Uses Atomics | No |
200-
| Lock-Free | Yes |
197+
| Allocates Memory | Yes |
198+
| Thread-Safe | No |
199+
| Uses Atomics | No |
200+
| Lock-Free | Yes |
201201

202202

203203
### function micro_ros_string_utilities_destroy
@@ -220,12 +220,12 @@ Destroys a rosidl_runtime_c__String.
220220
------------------
221221

222222

223-
| Attribute | Adherence |
223+
| Attribute | Adherence |
224224
| -------- | -------- |
225-
| Allocates Memory | Yes |
226-
| Thread-Safe | No |
227-
| Uses Atomics | No |
228-
| Lock-Free | Yes |
225+
| Allocates Memory | Yes |
226+
| Thread-Safe | No |
227+
| Uses Atomics | No |
228+
| Lock-Free | Yes |
229229

230230

231231

‎_includes/utils_doc/Modules/group__typeutils.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ Returns a string with the type introspection data.
4242
------------------
4343

4444

45-
| Attribute | Adherence |
45+
| Attribute | Adherence |
4646
| -------- | -------- |
47-
| Allocates Memory | Yes |
48-
| Thread-Safe | No |
49-
| Uses Atomics | No |
50-
| Lock-Free | Yes |
47+
| Allocates Memory | Yes |
48+
| Thread-Safe | No |
49+
| Uses Atomics | No |
50+
| Lock-Free | Yes |
5151

5252

5353
### function micro_ros_utilities_get_dynamic_size
@@ -74,12 +74,12 @@ Returns the dynamic memory size that will be used for a type.
7474
------------------
7575

7676

77-
| Attribute | Adherence |
77+
| Attribute | Adherence |
7878
| -------- | -------- |
79-
| Allocates Memory | Yes |
80-
| Thread-Safe | No |
81-
| Uses Atomics | No |
82-
| Lock-Free | Yes |
79+
| Allocates Memory | Yes |
80+
| Thread-Safe | No |
81+
| Uses Atomics | No |
82+
| Lock-Free | Yes |
8383

8484

8585
### function micro_ros_utilities_get_static_size
@@ -106,12 +106,12 @@ Returns the static memory size that will be used for a type.
106106
------------------
107107

108108

109-
| Attribute | Adherence |
109+
| Attribute | Adherence |
110110
| -------- | -------- |
111-
| Allocates Memory | Yes |
112-
| Thread-Safe | No |
113-
| Uses Atomics | No |
114-
| Lock-Free | Yes |
111+
| Allocates Memory | Yes |
112+
| Thread-Safe | No |
113+
| Uses Atomics | No |
114+
| Lock-Free | Yes |
115115

116116

117117
### function micro_ros_utilities_create_message_memory
@@ -140,12 +140,12 @@ Allocates the dynamic memory required for a message.
140140
------------------
141141

142142

143-
| Attribute | Adherence |
143+
| Attribute | Adherence |
144144
| -------- | -------- |
145-
| Allocates Memory | Yes |
146-
| Thread-Safe | No |
147-
| Uses Atomics | No |
148-
| Lock-Free | Yes |
145+
| Allocates Memory | Yes |
146+
| Thread-Safe | No |
147+
| Uses Atomics | No |
148+
| Lock-Free | Yes |
149149

150150

151151
### function micro_ros_utilities_create_static_message_memory
@@ -178,12 +178,12 @@ Allocates the memory required for a message in a user-provided buffer.
178178
------------------
179179

180180

181-
| Attribute | Adherence |
181+
| Attribute | Adherence |
182182
| -------- | -------- |
183-
| Allocates Memory | Yes |
184-
| Thread-Safe | No |
185-
| Uses Atomics | No |
186-
| Lock-Free | Yes |
183+
| Allocates Memory | Yes |
184+
| Thread-Safe | No |
185+
| Uses Atomics | No |
186+
| Lock-Free | Yes |
187187

188188

189189
### function micro_ros_utilities_destroy_message_memory
@@ -212,12 +212,12 @@ Deallocates the dynamic memory of a message.
212212
------------------
213213

214214

215-
| Attribute | Adherence |
215+
| Attribute | Adherence |
216216
| -------- | -------- |
217-
| Allocates Memory | Yes |
218-
| Thread-Safe | No |
219-
| Uses Atomics | No |
220-
| Lock-Free | Yes |
217+
| Allocates Memory | Yes |
218+
| Thread-Safe | No |
219+
| Uses Atomics | No |
220+
| Lock-Free | Yes |
221221

222222

223223

0 commit comments

Comments
 (0)