DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: apply one comment to all members of a group
@ 2014-09-17 17:21 Thomas Monjalon
  2014-09-29 14:42 ` Thomas Monjalon
  0 siblings, 1 reply; 2+ messages in thread
From: Thomas Monjalon @ 2014-09-17 17:21 UTC (permalink / raw)
  To: dev

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [dpdk-dev] [PATCH] doc: apply one comment to all members of a group
  2014-09-17 17:21 [dpdk-dev] [PATCH] doc: apply one comment to all members of a group Thomas Monjalon
@ 2014-09-29 14:42 ` Thomas Monjalon
  0 siblings, 0 replies; 2+ messages in thread
From: Thomas Monjalon @ 2014-09-29 14:42 UTC (permalink / raw)
  To: dev

> 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

-- 
Thomas

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2014-09-29 14:35 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-09-17 17:21 [dpdk-dev] [PATCH] doc: apply one comment to all members of a group Thomas Monjalon
2014-09-29 14:42 ` Thomas Monjalon

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git