From: Bruce Richardson <bruce.richardson@intel.com>
Date: Fri, 3 Oct 2014 15:36:52 +0000 (+0100)
Subject: mbuf: comment for ctrl mbuf flag
X-Git-Tag: spdx-start~10322
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=17c696b4ff3ee6327f037a1412d779c5f2b948f2;p=dpdk.git

mbuf: comment for ctrl mbuf flag

Add in a doxygen comment for the ctrl mbuf flag definition.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---

diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index 5fb09514ab..ddadc21545 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -115,7 +115,7 @@ extern "C" {
 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
 
 /* Use final bit of flags to indicate a control mbuf */
-#define CTRL_MBUF_FLAG       (1ULL << 63)
+#define CTRL_MBUF_FLAG       (1ULL << 63) /**< Mbuf contains control data */
 
 /**
  * Bit Mask to indicate what bits required for building TX context