Fix the doxygen warning by adding comments for enumeration.
Fixes: fad01fd77ac3 ("net/i40e: add dynamic device personalization processing")
Signed-off-by: Beilei Xing <beilei.x...@intel.com>
---
drivers/net/i40e/rte_pmd_i40e.h | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/drivers/net/i40e/rte_pmd_i40e.h b/drivers/net/i40e/rte_pmd_i40e.h
index 4486caf..8e15630 100644
--- a/drivers/net/i40e/rte_pmd_i40e.h
+++ b/drivers/net/i40e/rte_pmd_i40e.h
@@ -65,6 +65,9 @@ struct rte_pmd_i40e_mb_event_param {
uint16_t msglen; /**< length of the message */
};
+/**
+ * Option of package processing.
+ */
enum rte_pmd_i40e_package_op {
RTE_PMD_I40E_PKG_OP_UNDEFINED = 0,
RTE_PMD_I40E_PKG_OP_WR_ADD, /**< load package and add to info list */
@@ -74,7 +77,8 @@ enum rte_pmd_i40e_package_op {
#define RTE_PMD_I40E_DDP_NAME_SIZE 32
/**
- * Dynamic device personalization version
+ * Version for dynamic device personalization.
+ * Version in "major.minor.update.draft" format.
*/
struct rte_pmd_i40e_ddp_version {
uint8_t major;
@@ -84,7 +88,7 @@ struct rte_pmd_i40e_ddp_version {
};
/**
- * Structure of profile information
+ * Profile information in profile info list.
*/
struct rte_pmd_i40e_profile_info {
uint32_t track_id;
@@ -95,7 +99,7 @@ struct rte_pmd_i40e_profile_info {
};
/**
- * Structure of profile information list
+ * Profile information list returned from HW.
*/
struct rte_pmd_i40e_profile_list {
uint32_t p_count;
--
2.5.5
