diff --git a/_includes/utils_doc/Modules/group__typeutils.md b/_includes/utils_doc/Modules/group__typeutils.md index 8111b024..0c2b87e2 100644 --- a/_includes/utils_doc/Modules/group__typeutils.md +++ b/_includes/utils_doc/Modules/group__typeutils.md @@ -11,28 +11,6 @@ | MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf, uint8_t * buffer, size_t buffer_len)
Allocates the memory required for a message in a user-provided buffer. | | MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)
Deallocates the dynamic memory of a message. | -## Attributes - -| | Name | -| -------------- | -------------- | -| const micro_ros_utilities_memory_conf_t | **micro_ros_utilities_memory_conf_default** | - -## Types Documentation - -### typedef micro_ros_utilities_memory_rule_t - -```cpp -typedef struct micro_ros_utilities_memory_rule_t micro_ros_utilities_memory_rule_t; -``` - - -### typedef micro_ros_utilities_memory_conf_t - -```cpp -typedef struct micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_t; -``` - - ## Functions Documentation @@ -44,14 +22,14 @@ MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_utilities_type_inf ) ``` -Returns a string with the type instronspection data. +Returns a string with the type instronspection data. -**Parameters**: +**Parameters**: - * **type_support** ROS 2 typesupport + * **type_support** ROS 2 typesupport -**Return**: `rosidl_runtime_c__String` string containing data +**Return**: `rosidl_runtime_c__String` string containing data @@ -75,15 +53,15 @@ MICRO_ROS_UTILITIES_PUBLIC size_t micro_ros_utilities_get_dynamic_size( ) ``` -Returns the dynamic memory size that will be used for a type. +Returns the dynamic memory size that will be used for a type. -**Parameters**: +**Parameters**: - * **type_support** ROS 2 typesupport - * **conf** Utils configurator + * **type_support** ROS 2 typesupport + * **conf** Utils configurator -**Return**: `size_t` Size in Bytes that will be used +**Return**: `size_t` Size in Bytes that will be used @@ -107,15 +85,15 @@ MICRO_ROS_UTILITIES_PUBLIC size_t micro_ros_utilities_get_static_size( ) ``` -Returns the static memory size that will be used for a type. +Returns the static memory size that will be used for a type. -**Parameters**: +**Parameters**: - * **type_support** ROS 2 typesupport - * **conf** Utils configurator + * **type_support** ROS 2 typesupport + * **conf** Utils configurator -**Return**: `size_t` Size in Bytes that will be used +**Return**: `size_t` Size in Bytes that will be used @@ -140,16 +118,16 @@ MICRO_ROS_UTILITIES_PUBLIC bool micro_ros_utilities_create_message_memory( ) ``` -Allocates the dynamic memory required for a message. +Allocates the dynamic memory required for a message. -**Parameters**: +**Parameters**: - * **type_support** ROS 2 typesupport - * **ros_msg** ROS 2 msg with no type - * **conf** Utils configurator + * **type_support** ROS 2 typesupport + * **ros_msg** ROS 2 msg with no type + * **conf** Utils configurator -**Return**: `bool` true if success +**Return**: `bool` true if success @@ -176,18 +154,18 @@ MICRO_ROS_UTILITIES_PUBLIC bool micro_ros_utilities_create_static_message_memory ) ``` -Allocates the memory required for a message in a user-provided buffer. +Allocates the memory required for a message in a user-provided buffer. -**Parameters**: +**Parameters**: - * **type_support** ROS 2 typesupport - * **ros_msg** ROS 2 msg with no type - * **conf** Utils configurator - * **buffer** User buffer - * **buffer_len** User buffer length + * **type_support** ROS 2 typesupport + * **ros_msg** ROS 2 msg with no type + * **conf** Utils configurator + * **buffer** User buffer + * **buffer_len** User buffer length -**Return**: `bool` true if success +**Return**: `bool` true if success @@ -212,16 +190,16 @@ MICRO_ROS_UTILITIES_PUBLIC bool micro_ros_utilities_destroy_message_memory( ) ``` -Deallocates the dynamic memory of a message. +Deallocates the dynamic memory of a message. -**Parameters**: +**Parameters**: - * **type_support** ROS 2 typesupport - * **ros_msg** ROS 2 msg with no type - * **conf** Utils configurator + * **type_support** ROS 2 typesupport + * **ros_msg** ROS 2 msg with no type + * **conf** Utils configurator -**Return**: `bool` true if success +**Return**: `bool` true if success @@ -237,16 +215,6 @@ Deallocates the dynamic memory of a message. -## Attributes Documentation - -### variable micro_ros_utilities_memory_conf_default - -```cpp -static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_default = -{20, 5, 5, NULL, 0, NULL}; -``` - -