From 9245a40d7230275f79de53bf05197bf11f174686 Mon Sep 17 00:00:00 2001 From: Emerson Knapp Date: Thu, 23 Mar 2023 11:44:41 -0700 Subject: [PATCH] Explicit yaml dependency and doctext update Signed-off-by: Emerson Knapp --- rcl/CMakeLists.txt | 3 +++ rcl/include/rcl/type_hash.h | 6 ++++-- rcl/package.xml | 2 ++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/rcl/CMakeLists.txt b/rcl/CMakeLists.txt index 30339a3c8..9f4803295 100644 --- a/rcl/CMakeLists.txt +++ b/rcl/CMakeLists.txt @@ -4,6 +4,7 @@ project(rcl) find_package(ament_cmake_ros REQUIRED) +find_package(libyaml_vendor REQUIRED) find_package(rcl_interfaces REQUIRED) find_package(rcl_logging_interface REQUIRED) find_package(rcl_yaml_param_parser REQUIRED) @@ -14,6 +15,7 @@ find_package(rosidl_runtime_c REQUIRED) find_package(service_msgs REQUIRED) find_package(tracetools REQUIRED) find_package(type_description_interfaces REQUIRED) +find_package(yaml REQUIRED) include(cmake/rcl_set_symbol_visibility_hidden.cmake) include(cmake/get_default_rcl_logging_implementation.cmake) @@ -89,6 +91,7 @@ ament_target_dependencies(${PROJECT_NAME} "service_msgs" "tracetools" "type_description_interfaces" + "yaml" ) # Causes the visibility macros to use dllexport rather than dllimport, diff --git a/rcl/include/rcl/type_hash.h b/rcl/include/rcl/type_hash.h index 242a37bcd..9570c25f1 100644 --- a/rcl/include/rcl/type_hash.h +++ b/rcl/include/rcl/type_hash.h @@ -43,7 +43,8 @@ extern "C" * the JSON representation of type_description. Note that output_repr will have a * terminating null character, which should be omitted from hashing. To do so, use * (output_repr.buffer_length - 1) or strlen(output_repr.buffer) for the size of data to hash. - * \return RCL_RET_OK on success, RCL_RET_ERROR if any problems occur in translation + * \return #RCL_RET_OK on success, or + * \return #RCL_RET_ERROR if any problems occur in translation. */ RCL_PUBLIC rcl_ret_t @@ -61,7 +62,8 @@ rcl_type_description_to_hashable_json( * * \param[in] msg Prefilled TypeDescription message describing the type to be hashed * \param[out] message_digest Preallocated buffer, to be filled with calculated checksum - * \return RCL_RET_OK on success, RCL_RET_ERROR if any problems occur while hashing + * \return #RCL_RET_OK on success, or + * \return #RCL_RET_ERROR if any problems occur while hashing. */ RCL_PUBLIC rcl_ret_t diff --git a/rcl/package.xml b/rcl/package.xml index 720146f4e..e0c065563 100644 --- a/rcl/package.xml +++ b/rcl/package.xml @@ -19,6 +19,7 @@ rmw + libyaml_vendor rcl_interfaces rcl_logging_interface rcl_logging_spdlog @@ -29,6 +30,7 @@ service_msgs tracetools type_description_interfaces + yaml ament_cmake_gtest ament_lint_auto