update documentation (2)
authorMazet Laurent <laurent.mazet@thalesgroup.com>
Fri, 25 Apr 2025 04:12:27 +0000 (06:12 +0200)
committerMazet Laurent <laurent.mazet@thalesgroup.com>
Fri, 25 Apr 2025 04:12:27 +0000 (06:12 +0200)
parse.h
pdu_channel.h
pdu_clear_data.h
pdu_encrypted_data.h
pdu_key.h
pdu_prng_param.h
pdu_raw_data.h
pdu_status.h

diff --git a/parse.h b/parse.h
index 430abb19c9c20f61a8523119acfcd3faf6a6dcba..fdae8b9a96c3e28ffd62bfa727d312a057ba8f18 100644 (file)
--- a/parse.h
+++ b/parse.h
@@ -32,7 +32,12 @@ __BEGIN_DECLS
 */
 
 /**
-   @ingroup MESSAGES
+   @defgroup PARSE Public API of PARSE
+
+*/
+
+/**
+   @ingroup PARSE
 
    Test if a string contains only some characters or excludes them
 
@@ -55,7 +60,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Init parsing macro
 
@@ -93,7 +98,7 @@ __BEGIN_DECLS
         }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Parsing macro for integer field
 
@@ -107,7 +112,7 @@ __BEGIN_DECLS
             rc |= 1 << p;                                         \
         }
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Parsing macro for floating point field
 
@@ -122,7 +127,7 @@ __BEGIN_DECLS
         }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Parsing macro for array field
 
@@ -138,7 +143,7 @@ __BEGIN_DECLS
         }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Parsing macro for fix table size field
 
@@ -154,7 +159,7 @@ __BEGIN_DECLS
         }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    End of parsing macro
 */
@@ -169,7 +174,7 @@ __BEGIN_DECLS
 }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Initialize format section
 
@@ -182,7 +187,7 @@ __BEGIN_DECLS
     int len = 0;
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Format an integer field
 
@@ -196,7 +201,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Format a floating point field
 
@@ -210,7 +215,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Format an array field
 
@@ -226,7 +231,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Format an fix table size field
 
@@ -240,7 +245,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    End of format section
 */
@@ -248,7 +253,7 @@ __BEGIN_DECLS
     return (len >= _maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Initialize serialisation section
 
@@ -261,7 +266,7 @@ __BEGIN_DECLS
     int len = 0;
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Serialyze an integer field
 
@@ -299,7 +304,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Serialyze a floating point field
 
@@ -329,7 +334,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Serialyze an array field
 
@@ -346,7 +351,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Serialyze an fix table size field
 
@@ -363,7 +368,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    End of serialisation section
 */
@@ -371,7 +376,7 @@ __BEGIN_DECLS
     return len;
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Initialize deserialisation section
 
@@ -384,7 +389,7 @@ __BEGIN_DECLS
     uint8_t *ptr = _buffer;
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Deserialyze to an integer field
 
@@ -422,7 +427,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Deserialyze to a floating point field
 
@@ -452,7 +457,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Deserialyze to a fix size table field
 
@@ -469,7 +474,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Deserialyze to an array field
 
@@ -491,7 +496,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    End of deserialisation section
 */
@@ -499,7 +504,7 @@ __BEGIN_DECLS
     return (ptr > end);
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Initialize check section
 
@@ -512,7 +517,7 @@ __BEGIN_DECLS
     int rc = 0;
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Check two integer fields
 
@@ -531,7 +536,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Check two floating point fields
 
@@ -563,7 +568,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Check two fix size table fields
 
@@ -583,7 +588,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    Check two array fields
 
@@ -605,7 +610,7 @@ __BEGIN_DECLS
     }
 
 /**
-   @ingroup MESSAGES
+   @ingroup PARSE
 
    End of check section
 */
index 43066d90b920d654cb9aff185e2a28eda62e135b..81536822bb53a2e2189d92138f986d089dc69900 100644 (file)
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGE
+    @defgroup CHANNEL
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup CHANNEL
 
    Channel type
 */
@@ -33,7 +38,7 @@ typedef struct {
 } CHANNEL_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup CHANNEL
 
    Parse a string containing some channel type fields
 
@@ -44,7 +49,7 @@ typedef struct {
 int parse_channel (char *line, CHANNEL_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CHANNEL
 
    Format channel type fields into a string
 
@@ -56,7 +61,7 @@ int parse_channel (char *line, CHANNEL_t *out);
 int format_channel (CHANNEL_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CHANNEL
 
    Serial channel type fields into a network stream
 
@@ -68,7 +73,7 @@ int format_channel (CHANNEL_t *in, char *buffer, int maxlen);
 int serial_channel (CHANNEL_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CHANNEL
 
    Deserial channel type fields from a network stream
 
@@ -80,7 +85,7 @@ int serial_channel (CHANNEL_t *in, uint8_t *buffer, int maxlen);
 int deserial_channel (uint8_t *buffer, int len, CHANNEL_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CHANNEL
 
    Check two channel structures field by field
 
index af27aef0c455d9f4cf5c6ca75c17930f2ced10c4..8f98bacd8e35c81c4fbcf2520808f7e6c66156e1 100644 (file)
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGES
+    @defgroup CLEAR_DATA
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup CLEAR_DATA
 
    Clear data type
 */
@@ -36,7 +41,7 @@ typedef struct {
 } CLEAR_DATA_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup CLEAR_DATA
 
    Parse a string containing some clear data type fields
 
@@ -47,7 +52,7 @@ typedef struct {
 int parse_clear_data (char *line, CLEAR_DATA_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CLEAR_DATA
 
    Format clear data type fields into a string
 
@@ -59,7 +64,7 @@ int parse_clear_data (char *line, CLEAR_DATA_t *out);
 int format_clear_data (CLEAR_DATA_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CLEAR_DATA
 
    Serial clear data type fields into a network stream
 
@@ -71,7 +76,7 @@ int format_clear_data (CLEAR_DATA_t *in, char *buffer, int maxlen);
 int serial_clear_data (CLEAR_DATA_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CLEAR_DATA
 
    Deserial clear data type fields from a network stream
 
@@ -83,7 +88,7 @@ int serial_clear_data (CLEAR_DATA_t *in, uint8_t *buffer, int maxlen);
 int deserial_clear_data (uint8_t *buffer, int len, CLEAR_DATA_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup CLEAR_DATA
 
    Check two clear data structures field by field
 
index 5ceb478abf15375bc98a1b15a6c6c286a9ae4617..65979cd0cb2249616e25cc051c063d014a7a1b89 100644 (file)
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGE
+    @defgroup ENCRYPTED_DATA
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup ENCRYPTED_DATA
 
    Encrypted data type
 */
@@ -37,7 +42,7 @@ typedef struct {
 } ENCRYPTED_DATA_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup ENCRYPTED_DATA
 
    Parse a string containing some encrypted data type fields
 
@@ -48,7 +53,7 @@ typedef struct {
 int parse_encrypted_data (char *line, ENCRYPTED_DATA_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup ENCRYPTED_DATA
 
    Format encrypted data type fields into a string
 
@@ -60,7 +65,7 @@ int parse_encrypted_data (char *line, ENCRYPTED_DATA_t *out);
 int format_encrypted_data (ENCRYPTED_DATA_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup ENCRYPTED_DATA
 
    Serial encrypted data type fields into a network stream
 
@@ -72,7 +77,7 @@ int format_encrypted_data (ENCRYPTED_DATA_t *in, char *buffer, int maxlen);
 int serial_encrypted_data (ENCRYPTED_DATA_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup ENCRYPTED_DATA
 
    Deserial encrypted data type fields from a network stream
 
@@ -84,7 +89,7 @@ int serial_encrypted_data (ENCRYPTED_DATA_t *in, uint8_t *buffer, int maxlen);
 int deserial_encrypted_data (uint8_t *buffer, int len, ENCRYPTED_DATA_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup ENCRYPTED_DATA
 
    Check two encrypted data structures field by field
 
index ec359938aa5ad35709e732ee5bc8b09246303db5..cf9e6e5c9deeb628c8aa1aeba1164e6d72de1cc9 100644 (file)
--- a/pdu_key.h
+++ b/pdu_key.h
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGE
+    @defgroup KEY
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup KEY
 
    Key type
 */
@@ -34,7 +39,7 @@ typedef struct {
 } KEY_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup KEY
 
    Parse a string containing some key type fields
 
@@ -45,7 +50,7 @@ typedef struct {
 int parse_key (char *line, KEY_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup KEY
 
    Format key type fields into a string
 
@@ -57,7 +62,7 @@ int parse_key (char *line, KEY_t *out);
 int format_key (KEY_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup KEY
 
    Serial key type fields into a network stream
 
@@ -69,7 +74,7 @@ int format_key (KEY_t *in, char *buffer, int maxlen);
 int serial_key (KEY_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup KEY
 
    Deserial key type fields from a network stream
 
@@ -81,7 +86,7 @@ int serial_key (KEY_t *in, uint8_t *buffer, int maxlen);
 int deserial_key (uint8_t *buffer, int len, KEY_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup KEY
 
    Check two key structures field by field
 
index 59744264004d42969421f61295771448109c90e3..0c455d0d2338993400971173965c5183d4e40f55 100644 (file)
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGE
+    @defgroup PRNG_PARAM
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup PRNG_PARAM
 
    PRNG parameter type
 */
@@ -35,7 +40,7 @@ typedef struct {
 } PRNG_PARAM_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup PRNG_PARAM
 
    Parse a string containing some PRNG parameter type fields
 
@@ -46,7 +51,7 @@ typedef struct {
 int parse_prng_param (char *line, PRNG_PARAM_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup PRNG_PARAM
 
    Format PRNG parameter type fields into a string
 
@@ -58,7 +63,7 @@ int parse_prng_param (char *line, PRNG_PARAM_t *out);
 int format_prng_param (PRNG_PARAM_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup PRNG_PARAM
 
    Serial PRNG parameter type fields into a network stream
 
@@ -70,7 +75,7 @@ int format_prng_param (PRNG_PARAM_t *in, char *buffer, int maxlen);
 int serial_prng_param (PRNG_PARAM_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup PRNG_PARAM
 
    Deserial PRNG parameter type fields from a network stream
 
@@ -82,7 +87,7 @@ int serial_prng_param (PRNG_PARAM_t *in, uint8_t *buffer, int maxlen);
 int deserial_prng_param (uint8_t *buffer, int len, PRNG_PARAM_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup PRNG_PARAM
 
    Check two PRNG parameter structures field by field
 
index 5187b8af4e845aa662785bea5cbfb0f4815fb242..c9feb0362e2bcdbe105af49b71d9e54391fb306d 100644 (file)
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGES
+    @defgroup RAW_DATA
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup RAW_DATA
 
    Raw data type
 */
@@ -33,7 +38,7 @@ typedef struct {
 } RAW_DATA_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup RAW_DATA
 
    Parse a string containing some raw data type fields
 
@@ -44,7 +49,7 @@ typedef struct {
 int parse_raw_data (char *line, RAW_DATA_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup RAW_DATA
 
    Format raw data type fields into a string
 
@@ -56,7 +61,7 @@ int parse_raw_data (char *line, RAW_DATA_t *out);
 int format_raw_data (RAW_DATA_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup RAW_DATA
 
    Serialize raw data type fields into a network stream
 
@@ -68,7 +73,7 @@ int format_raw_data (RAW_DATA_t *in, char *buffer, int maxlen);
 int serial_raw_data (RAW_DATA_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup RAW_DATA
 
    Deserial raw data type fields from a network stream
 
@@ -80,7 +85,7 @@ int serial_raw_data (RAW_DATA_t *in, uint8_t *buffer, int maxlen);
 int deserial_raw_data (uint8_t *buffer, int len, RAW_DATA_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup RAW_DATA
 
    Check two raw data structures field by field
 
index b13f5d6b4a75074b4bcfb30d6f4679213a01fdc7..99ab11a562e7a2113c85dcfd8b2c1129d1fc25ba 100644 (file)
 __BEGIN_DECLS
 
 /**
-   @ingroup MESSAGE
+    @defgroup STATUS
+    @ingroup MESSAGES
+*/
+
+/**
+   @ingroup STATUS
 
    Status type
 */
@@ -32,7 +37,7 @@ typedef struct {
 } STATUS_t;
 
 /**
-   @ingroup MESSAGES
+   @ingroup STATUS
 
    Parse a string containing some status type fields
 
@@ -43,7 +48,7 @@ typedef struct {
 int parse_status (char *line, STATUS_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup STATUS
 
    Format status type fields into a string
 
@@ -55,7 +60,7 @@ int parse_status (char *line, STATUS_t *out);
 int format_status (STATUS_t *in, char *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup STATUS
 
    Serial status type fields into a network stream
 
@@ -67,7 +72,7 @@ int format_status (STATUS_t *in, char *buffer, int maxlen);
 int serial_status (STATUS_t *in, uint8_t *buffer, int maxlen);
 
 /**
-   @ingroup MESSAGES
+   @ingroup STATUS
 
    Deserial status type fields from a network stream
 
@@ -79,7 +84,7 @@ int serial_status (STATUS_t *in, uint8_t *buffer, int maxlen);
 int deserial_status (uint8_t *buffer, int len, STATUS_t *out);
 
 /**
-   @ingroup MESSAGES
+   @ingroup STATUS
 
    Check two status structures field by field