DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: apply one comment to all members of a group
Date: Wed, 17 Sep 2014 19:21:21 +0200	[thread overview]
Message-ID: <1410974481-609-1-git-send-email-thomas.monjalon@6wind.com> (raw)

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(-)

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
-- 
2.0.4

             reply	other threads:[~2014-09-17 17:16 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-09-17 17:21 Thomas Monjalon [this message]
2014-09-29 14:42 ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1410974481-609-1-git-send-email-thomas.monjalon@6wind.com \
    --to=thomas.monjalon@6wind.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).