DPDK patches and discussions
 help / color / mirror / Atom feed
From: Beilei Xing <beilei.xing@intel.com>
To: jingjing.wu@intel.com
Cc: helin.zhang@intel.com, dev@dpdk.org
Subject: [dpdk-dev] [PATCH] net/i40e: fix a doxygen warning
Date: Fri, 31 Mar 2017 09:49:26 +0800	[thread overview]
Message-ID: <1490924966-95148-1-git-send-email-beilei.xing@intel.com> (raw)

Fix the doxygen warning by adding comments for enumeration.

Fixes: fad01fd77ac3 ("net/i40e: add dynamic device personalization processing")

Signed-off-by: Beilei Xing <beilei.xing@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

             reply	other threads:[~2017-03-31  1:50 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-31  1:49 Beilei Xing [this message]
2017-03-31  9:59 ` Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1490924966-95148-1-git-send-email-beilei.xing@intel.com \
    --to=beilei.xing@intel.com \
    --cc=dev@dpdk.org \
    --cc=helin.zhang@intel.com \
    --cc=jingjing.wu@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).