From f893cdc49fa124fe749109b92fb113efcb48afd5 Mon Sep 17 00:00:00 2001 From: Karsten Knese Date: Mon, 16 Jul 2018 11:00:27 -0700 Subject: [PATCH 1/4] API doc --- rmw/include/rmw/rmw.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h index e5ec8178..8012e345 100644 --- a/rmw/include/rmw/rmw.h +++ b/rmw/include/rmw/rmw.h @@ -100,6 +100,22 @@ RMW_WARN_UNUSED const char * rmw_get_implementation_identifier(void); +/// Get the unique encoding identifier for this middleware. +/** + * The unique encoding identifier states in which encoding the + * serialized data has to be interpreted. + * One middleware can only have one encoding. + * In contrast to the implementation identifier, the encoding identifier can be + * equal between multiple RMW implementations. This means, that the same binary + * messages can be deserialized by RMW implementations with the same encoding ID. + * See also rmw_serialize, rmw_deserialize + * \return encoding identifier + */ +RMW_PUBLIC +RMW_WARN_UNUSED +const char * +rmw_get_encoding_identifier(void); + RMW_PUBLIC RMW_WARN_UNUSED rmw_ret_t From 2eb7bcac62682bfbedade3991447744cd347ca13 Mon Sep 17 00:00:00 2001 From: Karsten Knese Date: Mon, 16 Jul 2018 13:54:32 -0700 Subject: [PATCH 2/4] use doxygen \sa --- rmw/include/rmw/rmw.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h index 8012e345..8f830dfa 100644 --- a/rmw/include/rmw/rmw.h +++ b/rmw/include/rmw/rmw.h @@ -108,7 +108,8 @@ rmw_get_implementation_identifier(void); * In contrast to the implementation identifier, the encoding identifier can be * equal between multiple RMW implementations. This means, that the same binary * messages can be deserialized by RMW implementations with the same encoding ID. - * See also rmw_serialize, rmw_deserialize + * \sa rmw_serialize + * \sa rmw_deserialize * \return encoding identifier */ RMW_PUBLIC From 5ead9594c4c8f351a446b70ce84cc950d4f7fe60 Mon Sep 17 00:00:00 2001 From: Karsten Knese Date: Mon, 16 Jul 2018 14:10:29 -0700 Subject: [PATCH 3/4] encoding -> serialization format --- rmw/include/rmw/rmw.h | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h index 8f830dfa..56b8e85a 100644 --- a/rmw/include/rmw/rmw.h +++ b/rmw/include/rmw/rmw.h @@ -100,22 +100,21 @@ RMW_WARN_UNUSED const char * rmw_get_implementation_identifier(void); -/// Get the unique encoding identifier for this middleware. +/// Get the unique serialization format for this middleware. /** - * The unique encoding identifier states in which encoding the - * serialized data has to be interpreted. + * Return the format in which binary data is serialized. * One middleware can only have one encoding. - * In contrast to the implementation identifier, the encoding identifier can be + * In contrast to the implementation identifier, the serialization format can be * equal between multiple RMW implementations. This means, that the same binary - * messages can be deserialized by RMW implementations with the same encoding ID. + * messages can be deserialized by RMW implementations with the same format. * \sa rmw_serialize * \sa rmw_deserialize - * \return encoding identifier + * \return serialization format */ RMW_PUBLIC RMW_WARN_UNUSED const char * -rmw_get_encoding_identifier(void); +rmw_get_serialization_format(void); RMW_PUBLIC RMW_WARN_UNUSED From 1388f44b68c8a16078abcd02937c51f65bdb17e2 Mon Sep 17 00:00:00 2001 From: Karsten Knese Date: Thu, 26 Jul 2018 12:22:01 -0700 Subject: [PATCH 4/4] new lines in comment --- rmw/include/rmw/rmw.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/rmw/include/rmw/rmw.h b/rmw/include/rmw/rmw.h index 56b8e85a..b5e51fc9 100644 --- a/rmw/include/rmw/rmw.h +++ b/rmw/include/rmw/rmw.h @@ -104,9 +104,10 @@ rmw_get_implementation_identifier(void); /** * Return the format in which binary data is serialized. * One middleware can only have one encoding. - * In contrast to the implementation identifier, the serialization format can be - * equal between multiple RMW implementations. This means, that the same binary - * messages can be deserialized by RMW implementations with the same format. + * In contrast to the implementation identifier, the serialization format can be equal between + * multiple RMW implementations. + * This means, that the same binary messages can be deserialized by RMW implementations with the + * same format. * \sa rmw_serialize * \sa rmw_deserialize * \return serialization format