[dpdk-dev] doc: apply one comment to all members of a group
diff mbox

Message ID 1410974481-609-1-git-send-email-thomas.monjalon@6wind.com
State Accepted, archived
Headers show

Commit Message

Thomas Monjalon Sept. 17, 2014, 5:21 p.m. UTC
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>
---
 doc/doxy-api.conf          | 1 +
 lib/librte_port/rte_port.h | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

Comments

Thomas Monjalon Sept. 29, 2014, 2:42 p.m. UTC | #1
> 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>

Applied

Patch
diff mbox

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