Skip to content

micro-ROS Utils API reference auto-update 15-09-2021 06:25 #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogs9 merged 1 commit into from
Sep 15, 2021
Merged

micro-ROS Utils API reference auto-update 15-09-2021 06:25 #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions _includes/utils_doc/Modules/group__stringutils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
| -------------- | -------------- |
| 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. |
| 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. |
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_set](#function-micro_ros_string_utilities_set)**(rosidl_runtime_c__String str, const char * data)<br>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)**(rosidl_runtime_c__String str)<br>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)**(rosidl_runtime_c__String str, const char * data)<br>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)**(rosidl_runtime_c__String str, const size_t n)<br>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 * str)<br>Destroys a rosidl_runtime_c__String. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |


## Functions Documentation
Expand Down Expand Up @@ -79,7 +79,7 @@ Create a rosidl_runtime_c__String from a size.

```cpp
MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_string_utilities_set(
rosidl_runtime_c__String str,
const rosidl_runtime_c__String str,
const char * data
)
```
Expand Down Expand Up @@ -111,7 +111,7 @@ Create a rosidl_runtime_c__String from a char pointer.

```cpp
const MICRO_ROS_UTILITIES_PUBLIC char * micro_ros_string_utilities_get_c_str(
rosidl_runtime_c__String str
const rosidl_runtime_c__String str
)
```

Expand Down Expand Up @@ -141,7 +141,7 @@ Returns the char pointer to the rosidl_runtime_c__String data.

```cpp
rosidl_runtime_c__String micro_ros_string_utilities_append(
rosidl_runtime_c__String str,
const rosidl_runtime_c__String str,
const char * data
)
```
Expand Down Expand Up @@ -173,7 +173,7 @@ Appends a char pointer to the end of a rosidl_runtime_c__String.

```cpp
MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_string_utilities_remove_tail_chars(
rosidl_runtime_c__String str,
const rosidl_runtime_c__String str,
const size_t n
)
```
Expand Down Expand Up @@ -205,7 +205,7 @@ Removes characters from the end of a string.

```cpp
MICRO_ROS_UTILITIES_PUBLIC void micro_ros_string_utilities_destroy(
rosidl_runtime_c__String * str
rosidl_runtime_c__String *const str
)
```

Expand Down