From d5f7d3f662c8b639783e2ca267fb67faeea614f3 Mon Sep 17 00:00:00 2001 From: Alexander Bushnev Date: Mon, 7 Oct 2024 12:55:58 +0200 Subject: [PATCH] Fix c type formatting in documentation (#711) --- include/zenoh-pico/api/serialization.h | 100 ++++++++++++------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/include/zenoh-pico/api/serialization.h b/include/zenoh-pico/api/serialization.h index 09fa52773..d6e579557 100644 --- a/include/zenoh-pico/api/serialization.h +++ b/include/zenoh-pico/api/serialization.h @@ -84,7 +84,7 @@ ze_deserializer_t ze_deserializer_from_bytes(const z_loaned_bytes_t *bytes); bool ze_deserializer_is_done(const ze_deserializer_t *deserializer); /** - * Writes a serialized :c:type:`uint8_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `uint8_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -98,7 +98,7 @@ static inline z_result_t ze_serializer_serialize_uint8(ze_loaned_serializer_t *s } /** - * Writes a serialized :c:type:`uint16_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `uint16_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -113,7 +113,7 @@ static inline z_result_t ze_serializer_serialize_uint16(ze_loaned_serializer_t * } /** - * Writes a serialized :c:type:`uint32_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `uint32_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -128,7 +128,7 @@ static inline z_result_t ze_serializer_serialize_uint32(ze_loaned_serializer_t * } /** - * Writes a serialized :c:type:`uint64_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `uint64_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -143,7 +143,7 @@ static inline z_result_t ze_serializer_serialize_uint64(ze_loaned_serializer_t * } /** - * Writes a serialized :c:type:`float` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `float` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -157,7 +157,7 @@ static inline z_result_t ze_serializer_serialize_float(ze_loaned_serializer_t *s } /** - * Writes a serialized :c:type:`double` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `double` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -185,7 +185,7 @@ static inline z_result_t ze_serializer_serialize_bool(ze_loaned_serializer_t *se } /** - * Writes a serialized :c:type:`int8_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `int8_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -199,7 +199,7 @@ static inline z_result_t ze_serializer_serialize_int8(ze_loaned_serializer_t *se } /** - * Writes a serialized :c:type:`int16_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `int16_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -213,7 +213,7 @@ static inline z_result_t ze_serializer_serialize_int16(ze_loaned_serializer_t *s } /** - * Writes a serialized :c:type:`int32_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `int32_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -227,7 +227,7 @@ static inline z_result_t ze_serializer_serialize_int32(ze_loaned_serializer_t *s } /** - * Writes a serialized :c:type:`int64_t` into underlying :c:type:`z_owned_bytes_t`. + * Writes a serialized `int64_t` into underlying :c:type:`z_owned_bytes_t`. * * Parameters: * serializer: A serializer instance. @@ -245,7 +245,7 @@ static inline z_result_t ze_serializer_serialize_int64(ze_loaned_serializer_t *s * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`uint8_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint8_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -259,7 +259,7 @@ static inline z_result_t ze_deserializer_deserialize_uint8(ze_deserializer_t *de * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`uint16_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint16_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -277,7 +277,7 @@ static inline z_result_t ze_deserializer_deserialize_uint16(ze_deserializer_t *d * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`uint32_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint32_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -295,7 +295,7 @@ static inline z_result_t ze_deserializer_deserialize_uint32(ze_deserializer_t *d * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`uint64_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint64_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -313,7 +313,7 @@ static inline z_result_t ze_deserializer_deserialize_uint64(ze_deserializer_t *d * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`float` to contain the deserialized number. + * dst: Pointer to an uninitialized `float` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -330,7 +330,7 @@ static inline z_result_t ze_deserializer_deserialize_float(ze_deserializer_t *de * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`double` to contain the deserialized number. + * dst: Pointer to an uninitialized `double` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -367,7 +367,7 @@ static inline z_result_t ze_deserializer_deserialize_bool(ze_deserializer_t *des * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`int8_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int8_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -381,7 +381,7 @@ static inline z_result_t ze_deserializer_deserialize_int8(ze_deserializer_t *des * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`int16_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int16_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -395,7 +395,7 @@ static inline z_result_t ze_deserializer_deserialize_int16(ze_deserializer_t *de * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`int32_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int32_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -409,7 +409,7 @@ static inline z_result_t ze_deserializer_deserialize_int32(ze_deserializer_t *de * * Parameters: * deserializer: A deserializer instance. - * dst: Pointer to an uninitialized :c:type:`int64_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int64_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -568,7 +568,7 @@ z_result_t ze_serialize_str(z_owned_bytes_t *bytes, const char *value); z_result_t ze_serialize_slice(z_owned_bytes_t *bytes, const z_loaned_slice_t *slice); /** - * Serializes a :c:type:`int8_t` into a :c:type:`z_owned_bytes_t` . + * Serializes a `int8_t` into a :c:type:`z_owned_bytes_t` . * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -580,7 +580,7 @@ z_result_t ze_serialize_slice(z_owned_bytes_t *bytes, const z_loaned_slice_t *sl z_result_t ze_serialize_int8(z_owned_bytes_t *bytes, int8_t val); /** - * Serializes a :c:type:`int16_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `int16_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -592,7 +592,7 @@ z_result_t ze_serialize_int8(z_owned_bytes_t *bytes, int8_t val); z_result_t ze_serialize_int16(z_owned_bytes_t *bytes, int16_t val); /** - * Serializes a :c:type:`int32_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `int32_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -604,7 +604,7 @@ z_result_t ze_serialize_int16(z_owned_bytes_t *bytes, int16_t val); z_result_t ze_serialize_int32(z_owned_bytes_t *bytes, int32_t val); /** - * Serializes a :c:type:`int64_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `int64_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -616,7 +616,7 @@ z_result_t ze_serialize_int32(z_owned_bytes_t *bytes, int32_t val); z_result_t ze_serialize_int64(z_owned_bytes_t *bytes, int64_t val); /** - * Serializes a :c:type:`uint8_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `uint8_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -628,7 +628,7 @@ z_result_t ze_serialize_int64(z_owned_bytes_t *bytes, int64_t val); z_result_t ze_serialize_uint8(z_owned_bytes_t *bytes, uint8_t val); /** - * Serializes a :c:type:`uint16_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `uint16_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -640,7 +640,7 @@ z_result_t ze_serialize_uint8(z_owned_bytes_t *bytes, uint8_t val); z_result_t ze_serialize_uint16(z_owned_bytes_t *bytes, uint16_t val); /** - * Serializes a :c:type:`uint32_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `uint32_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -652,7 +652,7 @@ z_result_t ze_serialize_uint16(z_owned_bytes_t *bytes, uint16_t val); z_result_t ze_serialize_uint32(z_owned_bytes_t *bytes, uint32_t val); /** - * Serializes a :c:type:`uint64_t` into a :c:type:`z_owned_bytes_t`. + * Serializes a `uint64_t` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -664,7 +664,7 @@ z_result_t ze_serialize_uint32(z_owned_bytes_t *bytes, uint32_t val); z_result_t ze_serialize_uint64(z_owned_bytes_t *bytes, uint64_t val); /** - * Serializes a :c:type:`float` into a :c:type:`z_owned_bytes_t`. + * Serializes a `float` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -676,7 +676,7 @@ z_result_t ze_serialize_uint64(z_owned_bytes_t *bytes, uint64_t val); z_result_t ze_serialize_float(z_owned_bytes_t *bytes, float val); /** - * Serializes a :c:type:`double` into a :c:type:`z_owned_bytes_t`. + * Serializes a `double` into a :c:type:`z_owned_bytes_t`. * * Parameters: * bytes: An uninitialized :c:type:`z_owned_bytes_t` to contain the serialized int. @@ -724,11 +724,11 @@ z_result_t ze_deserialize_slice(const z_loaned_bytes_t *bytes, z_owned_slice_t * z_result_t ze_deserialize_string(const z_loaned_bytes_t *bytes, z_owned_string_t *str); /** - * Deserializes data into a `:c:type:`int8_t`. + * Deserializes data into a `int8_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`int8_t` to contain the deserialized. + * dst: Pointer to an uninitialized `int8_t` to contain the deserialized. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -736,11 +736,11 @@ z_result_t ze_deserialize_string(const z_loaned_bytes_t *bytes, z_owned_string_t z_result_t ze_deserialize_int8(const z_loaned_bytes_t *bytes, int8_t *dst); /** - * Deserializes data into a :c:type:`int16_t`. + * Deserializes data into a `int16_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`int16_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int16_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -748,11 +748,11 @@ z_result_t ze_deserialize_int8(const z_loaned_bytes_t *bytes, int8_t *dst); z_result_t ze_deserialize_int16(const z_loaned_bytes_t *bytes, int16_t *dst); /** - * Deserializes data into a :c:type:`int32_t`. + * Deserializes data into a `int32_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`int32_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int32_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -760,11 +760,11 @@ z_result_t ze_deserialize_int16(const z_loaned_bytes_t *bytes, int16_t *dst); z_result_t ze_deserialize_int32(const z_loaned_bytes_t *bytes, int32_t *dst); /** - * Deserializes data into a :c:type:`int64_t`. + * Deserializes data into a `int64_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`int64_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `int64_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -772,11 +772,11 @@ z_result_t ze_deserialize_int32(const z_loaned_bytes_t *bytes, int32_t *dst); z_result_t ze_deserialize_int64(const z_loaned_bytes_t *bytes, int64_t *dst); /** - * Deserializes data into a :c:type:`uint8_t`. + * Deserializes data into a `uint8_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`uint8_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint8_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -784,11 +784,11 @@ z_result_t ze_deserialize_int64(const z_loaned_bytes_t *bytes, int64_t *dst); z_result_t ze_deserialize_uint8(const z_loaned_bytes_t *bytes, uint8_t *dst); /** - * Deserializes data into a :c:type:`uint16_t`. + * Deserializes data into a `uint16_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`uint16_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint16_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -796,11 +796,11 @@ z_result_t ze_deserialize_uint8(const z_loaned_bytes_t *bytes, uint8_t *dst); z_result_t ze_deserialize_uint16(const z_loaned_bytes_t *bytes, uint16_t *dst); /** - * Deserializes data into a :c:type:`uint32_t`. + * Deserializes data into a `uint32_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`uint32_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint32_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -808,11 +808,11 @@ z_result_t ze_deserialize_uint16(const z_loaned_bytes_t *bytes, uint16_t *dst); z_result_t ze_deserialize_uint32(const z_loaned_bytes_t *bytes, uint32_t *dst); /** - * Deserializes data into a `:c:type:`uint64_t`. + * Deserializes data into a `uint64_t`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`uint64_t` to contain the deserialized number. + * dst: Pointer to an uninitialized `uint64_t` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -820,11 +820,11 @@ z_result_t ze_deserialize_uint32(const z_loaned_bytes_t *bytes, uint32_t *dst); z_result_t ze_deserialize_uint64(const z_loaned_bytes_t *bytes, uint64_t *dst); /** - * Deserializes data into a `:c:type:`float`. + * Deserializes data into a `float`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`float` to contain the deserialized number. + * dst: Pointer to an uninitialized `float` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise. @@ -832,11 +832,11 @@ z_result_t ze_deserialize_uint64(const z_loaned_bytes_t *bytes, uint64_t *dst); z_result_t ze_deserialize_float(const z_loaned_bytes_t *bytes, float *dst); /** - * Deserializes data into a :c:type:`double`. + * Deserializes data into a `double`. * * Parameters: * bytes: Pointer to a :c:type:`z_loaned_bytes_t` to deserialize. - * dst: Pointer to an uninitialized :c:type:`double` to contain the deserialized number. + * dst: Pointer to an uninitialized `double` to contain the deserialized number. * * Return: * ``0`` if deserialization successful, or a ``negative value`` otherwise.