From 80adfbac00278472def85f92453ed749cfcf9ceb Mon Sep 17 00:00:00 2001 From: Paul Fd Date: Fri, 16 Apr 2021 16:58:32 +0200 Subject: [PATCH 1/2] Comment struct members --- src/sfizz_message.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/sfizz_message.h b/src/sfizz_message.h index c5bd4ea7..e13678cf 100644 --- a/src/sfizz_message.h +++ b/src/sfizz_message.h @@ -32,22 +32,22 @@ extern "C" { * @since 1.0.0 */ typedef struct { - const uint8_t* data; - uint32_t size; + const uint8_t* data; /**< Pointer to the data */ + uint32_t size; /**< Data size */ } sfizz_blob_t; /** - * @brief Representation of an argument of variant type in OSC format + * @brief Representation of an argument of variant type in OSC format as an union * @since 1.0.0 */ typedef union { - int32_t i; - int64_t h; - float f; - double d; - const char* s; - const sfizz_blob_t* b; - uint8_t m[4]; + int32_t i; /**< int32_t union value */ + int64_t h; /**< int64_t union value */ + float f; /**< float union value */ + double d; /**< double union value */ + const char* s; /**< char* union value */ + const sfizz_blob_t* b; /**< blob union value */ + uint8_t m[4]; /**< 4-byte midi message union value */ } sfizz_arg_t; /** From 1466cdb7926a20b6b8c222c487ecf72feb2beed6 Mon Sep 17 00:00:00 2001 From: Paul Ferrand Date: Fri, 16 Apr 2021 17:20:44 +0200 Subject: [PATCH 2/2] Update src/sfizz_message.h Co-authored-by: JP Cimalando --- src/sfizz_message.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sfizz_message.h b/src/sfizz_message.h index e13678cf..79e2390f 100644 --- a/src/sfizz_message.h +++ b/src/sfizz_message.h @@ -37,7 +37,7 @@ typedef struct { } sfizz_blob_t; /** - * @brief Representation of an argument of variant type in OSC format as an union + * @brief Representation of an argument of variant type in OSC format as a union * @since 1.0.0 */ typedef union {