From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <h.mikita89@gmail.com>
Received: from mail-pa0-f68.google.com (mail-pa0-f68.google.com
[209.85.220.68]) by dpdk.org (Postfix) with ESMTP id B41D68D9D
for <dev@dpdk.org>; Wed, 6 Jul 2016 22:48:55 +0200 (CEST)
Received: by mail-pa0-f68.google.com with SMTP id dx3so5231725pab.2
for <dev@dpdk.org>; Wed, 06 Jul 2016 13:48:55 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
h=from:to:cc:subject:date:message-id;
bh=CbBFkiJ5n+lilpaYKB0fASAnoYknIeoAD2u063x0RfY=;
b=mfur5UEemEkxesS4B5u78moD1RefuRduXBcf/tNf6itOwvT+w3s4RMOrKUM/oUja3W
yUraucd7xpka92ooOC2XLze4VVF8JSZH+IdgjMbcGr61DXhBz28DAz3I4A6zmpiiWvql
PgImGzYAlyTXaVFMezw2TyCkRu7cK30Mj4e3rljXh9/AYCm9YEuBhV3xRBrqOHwvjPJo
h196k1qZ0xV7WdaGGafkk0X8699FH/5wiIuG8AC0GNn+W8Sa/mgXsR8lgamr84jnTBs5
WGvQ6AxZ7rMmpNrocv+1xcM7zCDLw5hrCzvcr21W+L84G5rFDgY9XFZVeaEyOZbB7UOu
JLcg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20130820;
h=x-gm-message-state:from:to:cc:subject:date:message-id;
bh=CbBFkiJ5n+lilpaYKB0fASAnoYknIeoAD2u063x0RfY=;
b=exs7W71vKc66fqWL+coTgJrTQopDlvUybYwbHNsXGva9/E2BQ51KpAU9SRwtMrJUlF
YVnBPCI25jcFp+Lo3UzvAFzLCJ9tijO6pRoc+o/hUgYzjCcYoDOIjE2xYu6hwEB1IwsA
keEmrE2CJR9xdfVrI/btoXRnTZrVBilYqiXXwoAOhIp7goPtMXI/1od7j6vGTMHshcYS
d4wIMXK+qoWyx4JY9C3xE4mFd0L+xe+YQnd+C0HlrO9dMMvp6SYd0O0GpQ28P/GyUWLE
3GevGGCTc06W3JWDFRs9TezcpDrrDhSIW+3xJdSSV7aewS4v+UxbslZQlzNfJZqZb3BL
NROA==
X-Gm-Message-State: ALyK8tIeivQuW9NdynzPvEjvOYh3ZsOspiJs/joaxH6w4QVAx3VxBx945yhw/gcH14zCFw==
X-Received: by 10.66.144.229 with SMTP id sp5mr9089444pab.97.1467838134875;
Wed, 06 Jul 2016 13:48:54 -0700 (PDT)
Received: from localhost.localdomain (183.180.67.214.ap.gmobb-fix.jp.
[183.180.67.214])
by smtp.gmail.com with ESMTPSA id 6sm5780490pfs.29.2016.07.06.13.48.53
(version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128);
Wed, 06 Jul 2016 13:48:54 -0700 (PDT)
From: Hiroyuki Mikita <h.mikita89@gmail.com>
To: konstantin.ananyev@intel.com
Cc: dev@dpdk.org
Date: Thu, 7 Jul 2016 05:48:45 +0900
Message-Id: <1467838125-31772-1-git-send-email-h.mikita89@gmail.com>
X-Mailer: git-send-email 2.7.4
Subject: [dpdk-dev] [PATCH] ip_frag: fix doxygen formatting
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: Wed, 06 Jul 2016 20:48:56 -0000
This commit fixes some functions missing in API documentation.
Signed-off-by: Hiroyuki Mikita <h.mikita89@gmail.com>
---
lib/librte_ip_frag/rte_ip_frag.h | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/lib/librte_ip_frag/rte_ip_frag.h b/lib/librte_ip_frag/rte_ip_frag.h
index 92cedf2..f8ed526 100644
--- a/lib/librte_ip_frag/rte_ip_frag.h
+++ b/lib/librte_ip_frag/rte_ip_frag.h
@@ -77,7 +77,7 @@ struct ip_frag_key {
uint32_t key_len; /**< src/dst key length */
};
-/*
+/**
* @internal Fragmented packet to reassemble.
* First two entries in the frags[] array are for the last and first fragments.
*/
@@ -151,7 +151,7 @@ struct ipv6_extension_fragment {
-/*
+/**
* Create a new IP fragmentation table.
*
* @param bucket_num
@@ -174,7 +174,7 @@ struct rte_ip_frag_tbl * rte_ip_frag_table_create(uint32_t bucket_num,
uint32_t bucket_entries, uint32_t max_entries,
uint64_t max_cycles, int socket_id);
-/*
+/**
* Free allocated IP fragmentation table.
*
* @param btl
@@ -215,7 +215,7 @@ rte_ipv6_fragment_packet(struct rte_mbuf *pkt_in,
struct rte_mempool *pool_direct,
struct rte_mempool *pool_indirect);
-/*
+/**
* This function implements reassembly of fragmented IPv6 packets.
* Incoming mbuf should have its l2_len/l3_len fields setup correctly.
*
@@ -241,7 +241,7 @@ struct rte_mbuf *rte_ipv6_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
struct rte_mbuf *mb, uint64_t tms, struct ipv6_hdr *ip_hdr,
struct ipv6_extension_fragment *frag_hdr);
-/*
+/**
* Return a pointer to the packet's fragment header, if found.
* It only looks at the extension header that's right after the fixed IPv6
* header, and doesn't follow the whole chain of extension headers.
@@ -291,7 +291,7 @@ int32_t rte_ipv4_fragment_packet(struct rte_mbuf *pkt_in,
struct rte_mempool *pool_direct,
struct rte_mempool *pool_indirect);
-/*
+/**
* This function implements reassembly of fragmented IPv4 packets.
* Incoming mbufs should have its l2_len/l3_len fields setup correclty.
*
@@ -314,7 +314,7 @@ struct rte_mbuf * rte_ipv4_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
struct rte_ip_frag_death_row *dr,
struct rte_mbuf *mb, uint64_t tms, struct ipv4_hdr *ip_hdr);
-/*
+/**
* Check if the IPv4 packet is fragmented
*
* @param hdr
@@ -333,7 +333,7 @@ rte_ipv4_frag_pkt_is_fragmented(const struct ipv4_hdr * hdr) {
return ip_flag != 0 || ip_ofs != 0;
}
-/*
+/**
* Free mbufs on a given death row.
*
* @param dr
@@ -345,7 +345,7 @@ void rte_ip_frag_free_death_row(struct rte_ip_frag_death_row *dr,
uint32_t prefetch);
-/*
+/**
* Dump fragmentation table statistics to file.
*
* @param f
--
2.7.4