summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Monjalon <thomas.monjalon@6wind.com>2014-09-17 18:11:12 +0200
committerThomas Monjalon <thomas.monjalon@6wind.com>2014-09-29 16:34:58 +0200
commitb66a2ca91e04b196a25ff2c357aac3cf43bbd12a (patch)
treebab1cb8f5717e8411be996d72318f405ae059bd2
parente35d434667f7832ed96a10386bbf8bf71afbeaaf (diff)
downloaddpdk-b66a2ca91e04b196a25ff2c357aac3cf43bbd12a.zip
dpdk-b66a2ca91e04b196a25ff2c357aac3cf43bbd12a.tar.gz
dpdk-b66a2ca91e04b196a25ff2c357aac3cf43bbd12a.tar.xz
doc: apply one comment to all members of a group
A doxygen group begins with /**@{*/ and ends with /**@}*/. By enabling DISTRIBUTE_GROUP_DOC, the first comment is applied to each undocumented member of the group. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
-rw-r--r--doc/doxy-api.conf1
-rw-r--r--lib/librte_port/rte_port.h3
2 files changed, 3 insertions, 1 deletions
diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf
index 63dc64d..124fc68 100644
--- a/doc/doxy-api.conf
+++ b/doc/doxy-api.conf
@@ -63,6 +63,7 @@ ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
EXTRACT_STATIC = YES
+DISTRIBUTE_GROUP_DOC = YES
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_SCOPE_NAMES = YES
diff --git a/lib/librte_port/rte_port.h b/lib/librte_port/rte_port.h
index 6bd5039..d84e5a1 100644
--- a/lib/librte_port/rte_port.h
+++ b/lib/librte_port/rte_port.h
@@ -50,7 +50,7 @@ extern "C" {
#include <stdint.h>
#include <rte_mbuf.h>
-/**
+/**@{
* Macros to allow accessing metadata stored in the mbuf headroom
* just beyond the end of the mbuf data structure returned by a port
*/
@@ -71,6 +71,7 @@ extern "C" {
(&RTE_MBUF_METADATA_UINT32(mbuf, offset))
#define RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset) \
(&RTE_MBUF_METADATA_UINT64(mbuf, offset))
+/**@}*/
/*
* Port IN