lib: fix doxygen syntax issues
PATCH 1/1 lib: fix doxygen syntax issues
From: Jerin Jacob <[email protected]>
Fix following syntax error reported by doxygen 1.9.5 version.
lib/eal/include/rte_uuid.h:89: error: RTE_UUID_STRLEN has @param documentation sections but no arguments (warning treated as error, aborting now)
lib/power/rte_power.h:169: error: rte_power_freq_up has @param documentation sections but no arguments (warning treated as error, aborting now)
--- lib/eal/include/rte_uuid.h | 4 ++- lib/power/rte_power.h | 55 -------------------------------------- 2 files changed, 3 insertions(+), 56 deletions(-)
lib/eal/include/rte_uuid.h +3 -1
@@ -37,6 +37,9 @@ typedef unsigned char rte_uuid_t[16]; ((e) >> 8) & 0xff, (e) & 0xff \ } +/** UUID string length */ +#define RTE_UUID_STRLEN (36 + 1) +/** * Test if UUID is all zeros. *
@@ -95,7 +98,6 @@ int rte_uuid_parse(const char *in, rte_uuid_t uu);* @param len * Sizeof the available string buffer */ -#define RTE_UUID_STRLEN (36 + 1)void rte_uuid_unparse (const rte_uuid_t uu,char *out,size_t len);#ifdef __cplusplus
lib/power/rte_power.h +0 -55
98 lines not on this page · raw message
Signature · 1 line
2.38.1
09/11/2022 15:54, [email protected]:
Quoted 8 lines
From: Jerin Jacob <[email protected]>
Fix following syntax error reported by doxygen 1.9.5 version.
lib/eal/include/rte_uuid.h:89: error:RTE_UUID_STRLENhas @param documentation sections but no arguments (warning treated as error, aborting now)
Quoted 6 lines
lib/power/rte_power.h:169: error:rte_power_freq_uphas @param documentation sections but no arguments (warning treated as error, aborting now)Fixes 6bc67c497a51 ("eal: add uuid API")Fixes d7937e2e3d12 ("power: initial import")
I think it deserves to be split in 2 patches.
If you agree, I can split when merging.
Quoted 14 lines · Thomas Monjalon
09/11/2022 15:54, [email protected]:
Quoted 12 lines
From: Jerin Jacob <[email protected]>
Fix following syntax error reported by doxygen 1.9.5 version.
lib/eal/include/rte_uuid.h:89: error:RTE_UUID_STRLENhas @param documentation sections but no arguments (warning treated as error, aborting now)
lib/power/rte_power.h:169: error:rte_power_freq_uphas @param documentation sections but no arguments (warning treated as error, aborting now)
Quoted 5 lines
Quoted 2 lines
Fixes 6bc67c497a51 ("eal: add uuid API")Fixes d7937e2e3d12 ("power: initial import")I think it deserves to be split in 2 patches.
If you agree, I can split when merging.
OK
Quoted 3 lines
Quoted 13 lines · On Wed, Nov 9, 2022 at 3:54 PM <[email protected]> wrote:
From: Jerin Jacob <[email protected]>
Fix following syntax error reported by doxygen 1.9.5 version.
lib/eal/include/rte_uuid.h:89: error:RTE_UUID_STRLENhas @param documentation sections but no arguments (warning treated as error, aborting now)
lib/power/rte_power.h:169: error:rte_power_freq_uphas @param documentation sections but no arguments (warning treated as error, aborting now)
Quoted 5 lines
Fixes 6bc67c497a51 ("eal: add uuid API")Fixes d7937e2e3d12 ("power: initial import")Signed-off-by Jerin Jacob <[email protected]>
I split the patch in two (as Thomas suggested) and applied it. Thanks.
Signature · 1 line
David Marchand