From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <smonroy@ecsmtp.ir.intel.com>
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
by dpdk.org (Postfix) with ESMTP id A998DB5BE
for <dev@dpdk.org>; Fri, 20 Feb 2015 13:10:57 +0100 (CET)
Received: from fmsmga002.fm.intel.com ([10.253.24.26])
by fmsmga103.fm.intel.com with ESMTP; 20 Feb 2015 04:03:15 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.09,614,1418112000"; d="scan'208";a="680840936"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
by fmsmga002.fm.intel.com with ESMTP; 20 Feb 2015 04:10:54 -0800
Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com
[10.237.217.46])
by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id
t1KCAsWN006193 for <dev@dpdk.org>; Fri, 20 Feb 2015 12:10:54 GMT
Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1])
by sivswdev02.ir.intel.com with ESMTP id t1KCAsnr006861
for <dev@dpdk.org>; Fri, 20 Feb 2015 12:10:54 GMT
Received: (from smonroy@localhost)
by sivswdev02.ir.intel.com with id t1KCAsJR006857
for dev@dpdk.org; Fri, 20 Feb 2015 12:10:54 GMT
From: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
To: dev@dpdk.org
Date: Fri, 20 Feb 2015 12:10:52 +0000
Message-Id: <1424434253-6808-3-git-send-email-sergio.gonzalez.monroy@intel.com>
X-Mailer: git-send-email 1.8.5.4
In-Reply-To: <1424434253-6808-1-git-send-email-sergio.gonzalez.monroy@intel.com>
References: <1424434253-6808-1-git-send-email-sergio.gonzalez.monroy@intel.com>
Subject: [dpdk-dev] [PATCH 2/3] mbuf: fix a couple of doxygen comments
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 20 Feb 2015 12:10:58 -0000
Fix a couple of doxygen comments in mbuf structure:
- seqn had no doxygen syntax.
- usr was not generating proper link to function.
Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
---
lib/librte_mbuf/rte_mbuf.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
index ace6736..32e957b 100644
--- a/lib/librte_mbuf/rte_mbuf.h
+++ b/lib/librte_mbuf/rte_mbuf.h
@@ -286,11 +286,11 @@ struct rte_mbuf {
PKT_RX_FDIR_* flag in ol_flags. */
} fdir; /**< Filter identifier if FDIR enabled */
uint32_t sched; /**< Hierarchical scheduler */
- uint32_t usr; /**< User defined tags. See @rte_distributor_process */
+ uint32_t usr; /**< User defined tags. See rte_distributor_process() */
} hash; /**< hash information */
- /* sequence number - field used in distributor and reorder library */
uint32_t seqn;
+ /**< Sequence number. See also rte_reorder_insert() */
/* second cache line - fields only used in slow path or on TX */
MARKER cacheline1 __rte_cache_aligned;
--
1.9.3