From 822e3a7a49e7d97987c53675d615c12698027907 Mon Sep 17 00:00:00 2001 From: Acuadros95 Date: Tue, 13 Jun 2023 12:21:51 +0000 Subject: [PATCH] micro-ROS Utils API reference auto-update 13-06-2023 12:21 --- .../utils_doc/Modules/group__stringutils.md | 74 +++++++++---------- .../utils_doc/Modules/group__typeutils.md | 60 +++++++-------- 2 files changed, 67 insertions(+), 67 deletions(-) diff --git a/_includes/utils_doc/Modules/group__stringutils.md b/_includes/utils_doc/Modules/group__stringutils.md index efba4115..322bba7e 100644 --- a/_includes/utils_doc/Modules/group__stringutils.md +++ b/_includes/utils_doc/Modules/group__stringutils.md @@ -7,7 +7,7 @@ | MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_init](#function-micro_ros_string_utilities_init)**(const char * data)
Create a rosidl_runtime_c__String from a char pointer. | | 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)
Create a rosidl_runtime_c__String from a size. | | 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)
Create a rosidl_runtime_c__String from a char pointer. | -| 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)
Returns the char pointer to the rosidl_runtime_c__String data. | +| 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)
Returns the char pointer to the rosidl_runtime_c__String data. | | rosidl_runtime_c__String | **[micro_ros_string_utilities_append](#function-micro_ros_string_utilities_append)**(const rosidl_runtime_c__String str, const char * data)
Appends a char pointer to the end of a rosidl_runtime_c__String. | | 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)
Removes characters from the end of a string. | | MICRO_ROS_UTILITIES_PUBLIC void | **[micro_ros_string_utilities_destroy](#function-micro_ros_string_utilities_destroy)**(rosidl_runtime_c__String *const str)
Destroys a rosidl_runtime_c__String. | @@ -36,12 +36,12 @@ Create a rosidl_runtime_c__String from a char pointer. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_string_utilities_init_with_size @@ -66,12 +66,12 @@ Create a rosidl_runtime_c__String from a size. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_string_utilities_set @@ -98,18 +98,18 @@ Create a rosidl_runtime_c__String from a char pointer. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_string_utilities_get_c_str ```cpp -const MICRO_ROS_UTILITIES_PUBLIC char * micro_ros_string_utilities_get_c_str( +MICRO_ROS_UTILITIES_PUBLIC const char * micro_ros_string_utilities_get_c_str( const rosidl_runtime_c__String str ) ``` @@ -128,12 +128,12 @@ Returns the char pointer to the rosidl_runtime_c__String data. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_string_utilities_append @@ -160,12 +160,12 @@ Appends a char pointer to the end of a rosidl_runtime_c__String. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_string_utilities_remove_tail_chars @@ -192,12 +192,12 @@ Removes characters from the end of a string. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_string_utilities_destroy @@ -220,12 +220,12 @@ Destroys a rosidl_runtime_c__String. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | diff --git a/_includes/utils_doc/Modules/group__typeutils.md b/_includes/utils_doc/Modules/group__typeutils.md index a422a81e..f0de6cef 100644 --- a/_includes/utils_doc/Modules/group__typeutils.md +++ b/_includes/utils_doc/Modules/group__typeutils.md @@ -42,12 +42,12 @@ Returns a string with the type introspection data. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_utilities_get_dynamic_size @@ -74,12 +74,12 @@ Returns the dynamic memory size that will be used for a type. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_utilities_get_static_size @@ -106,12 +106,12 @@ Returns the static memory size that will be used for a type. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_utilities_create_message_memory @@ -140,12 +140,12 @@ Allocates the dynamic memory required for a message. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_utilities_create_static_message_memory @@ -178,12 +178,12 @@ Allocates the memory required for a message in a user-provided buffer. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | ### function micro_ros_utilities_destroy_message_memory @@ -212,12 +212,12 @@ Deallocates the dynamic memory of a message. ------------------ -| Attribute | Adherence | +| Attribute | Adherence | | -------- | -------- | -| Allocates Memory | Yes | -| Thread-Safe | No | -| Uses Atomics | No | -| Lock-Free | Yes | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes |