From e48839afffc4c1642ea2c8c5394f68ec657a1dbe Mon Sep 17 00:00:00 2001 From: Gaetan Rivet Date: Thu, 20 Dec 2018 18:06:46 +0100 Subject: [PATCH] eal: improve option API documentation Use doxygen to describe the main structure and describe a little more why it exists. Signed-off-by: Gaetan Rivet --- lib/librte_eal/common/include/rte_option.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/librte_eal/common/include/rte_option.h b/lib/librte_eal/common/include/rte_option.h index eea95e477b..20be47d912 100644 --- a/lib/librte_eal/common/include/rte_option.h +++ b/lib/librte_eal/common/include/rte_option.h @@ -29,8 +29,12 @@ extern "C" { typedef int (*rte_option_cb)(void); -/* - * Structure describing the EAL command line option being registered. +/** + * Structure describing an EAL command line option dynamically registered. + * + * Common EAL options are mostly statically defined. + * Some libraries need additional options to be dynamically added. + * This structure describes such options. */ struct rte_option { TAILQ_ENTRY(rte_option) next; /**< Next entry in the list. */ -- 2.20.1