From b66a2ca91e04b196a25ff2c357aac3cf43bbd12a Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Wed, 17 Sep 2014 18:11:12 +0200 Subject: [PATCH] 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 --- doc/doxy-api.conf | 1 + lib/librte_port/rte_port.h | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf index 63dc64df06..124fc68b2c 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 6bd5039484..d84e5a1285 100644 --- a/lib/librte_port/rte_port.h +++ b/lib/librte_port/rte_port.h @@ -50,7 +50,7 @@ extern "C" { #include #include -/** +/**@{ * 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 -- 2.20.1