From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wg0-f44.google.com (mail-wg0-f44.google.com [74.125.82.44]) by dpdk.org (Postfix) with ESMTP id 58A25B3AA for ; Wed, 17 Sep 2014 19:16:47 +0200 (CEST) Received: by mail-wg0-f44.google.com with SMTP id b13so882422wgh.27 for ; Wed, 17 Sep 2014 10:22:29 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=BDRkycnkQQhVYOyNsAhcWy1FWGvcASGRaZaUGKW7AP0=; b=nDmz24SVZXO1Gnyzx6bDAFIucckVbb3uJFmsS9n08k3F7H+l8tgG2+0GpgkxJv6nal Z6ps9ERVH5MJ+hAORs78XZxs2vjeBvs4F31qppwolqn+/ppgrd46s/GxrpPxwGfLuxpV OoiKkYD1apByCq3jg/g2ijzsoH75ceiB/C9KkFpoe83jOk0Jss4X42hzS5ddXQVu+eUG qGCtHmVotcJ/FPYPHeZax9TRMe9+AK/ZYgEwQmE7XAgqCvIsYSks/ueoozxzi1fAUXOb RCUtiGW4p9ktPxNvWOlw0M+7gWks/MGyjfX39zgYvS3fJISoONpGlr8zs7gZBEEJ9Bh/ n0jw== X-Gm-Message-State: ALoCoQk3+6x/x+SPfDKj1jd6Dd5bxcjSdY/5vFXN0haE4Kr61gQMiKRJ2P6Sub92mDiA59dyre81 X-Received: by 10.195.12.103 with SMTP id ep7mr4834518wjd.121.1410974548781; Wed, 17 Sep 2014 10:22:28 -0700 (PDT) Received: from localhost.localdomain (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by mx.google.com with ESMTPSA id fo6sm6344058wic.3.2014.09.17.10.22.27 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 17 Sep 2014 10:22:28 -0700 (PDT) From: Thomas Monjalon To: dev@dpdk.org Date: Wed, 17 Sep 2014 19:21:21 +0200 Message-Id: <1410974481-609-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.0.4 Subject: [dpdk-dev] [PATCH] doc: apply one comment to all members of a group X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 17 Sep 2014 17:16:47 -0000 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 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 #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.0.4