From patchwork Thu Jul 9 13:46:25 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Uvarov X-Patchwork-Id: 50968 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f199.google.com (mail-lb0-f199.google.com [209.85.217.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 235E1228E5 for ; Thu, 9 Jul 2015 13:54:45 +0000 (UTC) Received: by lbnk3 with SMTP id k3sf13530959lbn.2 for ; Thu, 09 Jul 2015 06:54:44 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:in-reply-to:references:cc:subject:precedence:list-id :list-unsubscribe:list-archive:list-post:list-help:list-subscribe :mime-version:content-type:content-transfer-encoding:errors-to :sender:x-original-sender:x-original-authentication-results :mailing-list; bh=rIJHAwQRCiNcg0XbPhL/PNwFA3P805fMCtrho7BsMDE=; b=aaRqSMyOG0IMaMubkobs1oVEDhUT62i1Hrq8brfoxHUR2NmgVlsLWYI77nGE8jPObP 0dlemEetcHySsuD1b5Aha59q5PZ+xZKe2m3D5WG28Mr5Kqz4wgRNCSv2sLys9HToaJ99 m6NI9Aiexm4/nqWp7WZi9d13f/+beIUBOe19xqNg415yvGD9NM1O+C4NPKosiHRkcUIR /Z+b+aKBtn+ls0zEa7aSXrFM5zflfFVq9YI2WJyMv6+WwnSw66BKxkFRMBBuApat9JDl 8KYlqkjJllsFDjQn5tzntse+V7qkDChUkj7y8cKJHtJS2niBC2d475P4W2bB+FBoO9BN JgXQ== X-Gm-Message-State: ALoCoQnNbH1qDpato8UxuQpLRUb+6847ZBWNQlv/1nVus6JmMLQvLXWbrYyQnwkpbcEjxSEm/QS9 X-Received: by 10.194.179.42 with SMTP id dd10mr8013731wjc.7.1436450084090; Thu, 09 Jul 2015 06:54:44 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.37.8 with SMTP id u8ls1113065laj.39.gmail; Thu, 09 Jul 2015 06:54:43 -0700 (PDT) X-Received: by 10.112.97.145 with SMTP id ea17mr14622423lbb.49.1436450083914; Thu, 09 Jul 2015 06:54:43 -0700 (PDT) Received: from mail-lb0-f170.google.com (mail-lb0-f170.google.com. [209.85.217.170]) by mx.google.com with ESMTPS id db5si4560380lac.73.2015.07.09.06.54.43 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 09 Jul 2015 06:54:43 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.170 as permitted sender) client-ip=209.85.217.170; Received: by lbnk3 with SMTP id k3so75565059lbn.1 for ; Thu, 09 Jul 2015 06:54:43 -0700 (PDT) X-Received: by 10.152.18.162 with SMTP id x2mr15003031lad.73.1436450083714; Thu, 09 Jul 2015 06:54:43 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.108.230 with SMTP id hn6csp684479lbb; Thu, 9 Jul 2015 06:54:42 -0700 (PDT) X-Received: by 10.140.235.145 with SMTP id g139mr25841140qhc.81.1436450082228; Thu, 09 Jul 2015 06:54:42 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 102si6849849qgk.119.2015.07.09.06.54.40; Thu, 09 Jul 2015 06:54:42 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id D2D8661FCB; Thu, 9 Jul 2015 13:54:40 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 63EF461FD2; Thu, 9 Jul 2015 13:48:35 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 25D0461FEB; Thu, 9 Jul 2015 13:48:27 +0000 (UTC) Received: from mail-wi0-f169.google.com (mail-wi0-f169.google.com [209.85.212.169]) by lists.linaro.org (Postfix) with ESMTPS id 8F21361FD1 for ; Thu, 9 Jul 2015 13:46:51 +0000 (UTC) Received: by widjy10 with SMTP id jy10so245520056wid.1 for ; Thu, 09 Jul 2015 06:46:50 -0700 (PDT) X-Received: by 10.194.185.236 with SMTP id ff12mr33181657wjc.134.1436449610759; Thu, 09 Jul 2015 06:46:50 -0700 (PDT) Received: from localhost.localdomain ([87.120.178.39]) by smtp.gmail.com with ESMTPSA id df1sm8414627wib.12.2015.07.09.06.46.49 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 09 Jul 2015 06:46:49 -0700 (PDT) From: Maxim Uvarov To: lng-odp@lists.linaro.org Date: Thu, 9 Jul 2015 16:46:25 +0300 Message-Id: <1436449585-23252-12-git-send-email-maxim.uvarov@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1436449585-23252-1-git-send-email-maxim.uvarov@linaro.org> References: <1436449585-23252-1-git-send-email-maxim.uvarov@linaro.org> X-Topics: patch Cc: Petri Savolainen Subject: [lng-odp] [PATCH 11/11] api: doc: doxygen grouping clean up X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: maxim.uvarov@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.170 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 From: Petri Savolainen Cleaned Doxygen documentation grouping. Corrected wrong groupings and created new groups when needed. Signed-off-by: Petri Savolainen Reviewed-by: Bill Fischofer Signed-off-by: Maxim Uvarov --- include/odp/api/buffer.h | 11 ----------- include/odp/api/config.h | 2 +- include/odp/api/cpumask.h | 2 +- include/odp/api/debug.h | 14 +++----------- include/odp/api/errno.h | 2 +- include/odp/api/pool.h | 2 +- include/odp/api/system_info.h | 2 +- include/odp/api/time.h | 2 +- include/odp/api/version.h | 2 +- platform/linux-generic/include/odp/config.h | 8 -------- platform/linux-generic/include/odp/cpumask.h | 8 -------- platform/linux-generic/include/odp/errno.h | 6 ------ platform/linux-generic/include/odp/plat/buffer_types.h | 9 --------- platform/linux-generic/include/odp/plat/cpumask_types.h | 2 +- platform/linux-generic/include/odp/system_info.h | 7 ------- platform/linux-generic/include/odp/time.h | 6 ------ 16 files changed, 11 insertions(+), 74 deletions(-) diff --git a/include/odp/api/buffer.h b/include/odp/api/buffer.h index 9ad08ea..aea273f 100644 --- a/include/odp/api/buffer.h +++ b/include/odp/api/buffer.h @@ -24,7 +24,6 @@ extern "C" { * @{ */ - /** * @typedef odp_buffer_t * ODP buffer @@ -36,16 +35,6 @@ extern "C" { */ /** - * @typedef odp_buffer_seg_t - * ODP buffer segment - */ - -/** - * @def ODP_SEGMENT_INVALID - * Invalid segment - */ - -/** * Get buffer handle from event * * Converts an ODP_EVENT_BUFFER type event to a buffer. diff --git a/include/odp/api/config.h b/include/odp/api/config.h index 91ea34e..b5c8fdd 100644 --- a/include/odp/api/config.h +++ b/include/odp/api/config.h @@ -18,7 +18,7 @@ extern "C" { #endif -/** @addtogroup odp_compiler_optim +/** @defgroup odp_config ODP CONFIG * Macro for maximum number of resources in ODP. * @{ */ diff --git a/include/odp/api/cpumask.h b/include/odp/api/cpumask.h index 02fd131..2ad7fea 100644 --- a/include/odp/api/cpumask.h +++ b/include/odp/api/cpumask.h @@ -20,7 +20,7 @@ extern "C" { #include -/** @addtogroup odp_scheduler +/** @defgroup odp_cpumask ODP CPUMASK * CPU mask operations. * @{ */ diff --git a/include/odp/api/debug.h b/include/odp/api/debug.h index 660569f..252a82f 100644 --- a/include/odp/api/debug.h +++ b/include/odp/api/debug.h @@ -17,18 +17,13 @@ extern "C" { #endif -/** @addtogroup odp_ver_abt_log_dbg - * Macros that allows different messages. - * @{ - */ - #if defined(__GNUC__) && !defined(__clang__) #if __GNUC__ < 4 || (__GNUC__ == 4 && (__GNUC_MINOR__ < 6)) /** - * _Static_assert was only added in GCC 4.6. Provide a weak replacement + * @internal _Static_assert was only added in GCC 4.6. Provide a weak replacement * for previous versions. */ #define _Static_assert(e, s) (extern int (*static_assert_checker(void)) \ @@ -42,14 +37,11 @@ extern "C" { /** - * Compile time assertion-macro - fail compilation if cond is false. - * @note This macro has zero runtime overhead + * @internal Compile time assertion-macro - fail compilation if cond is false. + * This macro has zero runtime overhead */ #define _ODP_STATIC_ASSERT(cond, msg) _Static_assert(cond, msg) -/** - * @} - */ #ifdef __cplusplus } diff --git a/include/odp/api/errno.h b/include/odp/api/errno.h index 527214e..9829807 100644 --- a/include/odp/api/errno.h +++ b/include/odp/api/errno.h @@ -17,7 +17,7 @@ extern "C" { #endif -/** @addtogroup odp_ver_abt_log_dbg +/** @defgroup odp_errno ODP ERRNO * @{ */ diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h index c679781..a813d33 100644 --- a/include/odp/api/pool.h +++ b/include/odp/api/pool.h @@ -22,7 +22,7 @@ extern "C" { #include -/** @addtogroup odp_buffer +/** @defgroup odp_pool ODP POOL * Operations on a pool. * @{ */ diff --git a/include/odp/api/system_info.h b/include/odp/api/system_info.h index 1f3294b..e55ff6d 100644 --- a/include/odp/api/system_info.h +++ b/include/odp/api/system_info.h @@ -19,7 +19,7 @@ extern "C" { #endif -/** @addtogroup odp_ver_abt_log_dbg +/** @defgroup odp_system ODP SYSTEM * @{ */ diff --git a/include/odp/api/time.h b/include/odp/api/time.h index 836866d..b0072fc 100644 --- a/include/odp/api/time.h +++ b/include/odp/api/time.h @@ -19,7 +19,7 @@ extern "C" { #endif -/** @defgroup odp_system ODP SYSTEM +/** @defgroup odp_time ODP TIME * @{ */ diff --git a/include/odp/api/version.h b/include/odp/api/version.h index 5d1abfa..93fbacf 100644 --- a/include/odp/api/version.h +++ b/include/odp/api/version.h @@ -18,7 +18,7 @@ extern "C" { #endif -/** @defgroup odp_ver_abt_log_dbg ODP LOGGING / ABORT / VERSION / DEBUG / ERRNO +/** @defgroup odp_version ODP VERSION * @{ */ diff --git a/platform/linux-generic/include/odp/config.h b/platform/linux-generic/include/odp/config.h index b0211b1..6fecd38 100644 --- a/platform/linux-generic/include/odp/config.h +++ b/platform/linux-generic/include/odp/config.h @@ -17,14 +17,6 @@ extern "C" { #endif -/** @ingroup odp_compiler_optim - * @{ - */ - -/** - * @} - */ - #include #ifdef __cplusplus diff --git a/platform/linux-generic/include/odp/cpumask.h b/platform/linux-generic/include/odp/cpumask.h index f09bb91..cf7ad9d 100644 --- a/platform/linux-generic/include/odp/cpumask.h +++ b/platform/linux-generic/include/odp/cpumask.h @@ -23,14 +23,6 @@ extern "C" { #include #include -/** @ingroup odp_scheduler - * @{ - */ - -/** - * @} - */ - #include #ifdef __cplusplus diff --git a/platform/linux-generic/include/odp/errno.h b/platform/linux-generic/include/odp/errno.h index 3e9e1fa..e53b49c 100644 --- a/platform/linux-generic/include/odp/errno.h +++ b/platform/linux-generic/include/odp/errno.h @@ -17,13 +17,7 @@ extern "C" { #endif -/** @addtogroup odp_ver_abt_log_dbg - * @{ - */ -/** - * @} - */ #include #ifdef __cplusplus diff --git a/platform/linux-generic/include/odp/plat/buffer_types.h b/platform/linux-generic/include/odp/plat/buffer_types.h index 0c017ae..3203020 100644 --- a/platform/linux-generic/include/odp/plat/buffer_types.h +++ b/platform/linux-generic/include/odp/plat/buffer_types.h @@ -20,11 +20,6 @@ extern "C" { #include #include -/** @addtogroup odp_buffer ODP BUFFER - * Operations on a buffer. - * @{ - */ - /** ODP buffer */ typedef ODP_HANDLE_T(odp_buffer_t); @@ -43,10 +38,6 @@ static inline uint64_t odp_buffer_to_u64(odp_buffer_t hdl) return _odp_pri(hdl); } -/** - * @} - */ - #ifdef __cplusplus } #endif diff --git a/platform/linux-generic/include/odp/plat/cpumask_types.h b/platform/linux-generic/include/odp/plat/cpumask_types.h index df3c797..6fba832 100644 --- a/platform/linux-generic/include/odp/plat/cpumask_types.h +++ b/platform/linux-generic/include/odp/plat/cpumask_types.h @@ -18,7 +18,7 @@ extern "C" { #endif -/** @addtogroup odp_compiler_optim +/** @addtogroup odp_cpumask * @{ */ diff --git a/platform/linux-generic/include/odp/system_info.h b/platform/linux-generic/include/odp/system_info.h index 1e8811c..d692606 100644 --- a/platform/linux-generic/include/odp/system_info.h +++ b/platform/linux-generic/include/odp/system_info.h @@ -19,13 +19,6 @@ extern "C" { #include -/** @ingroup odp_ver_abt_log_dbg - * @{ - */ - -/** - * @} - */ #include diff --git a/platform/linux-generic/include/odp/time.h b/platform/linux-generic/include/odp/time.h index 0620ebd..3a3960b 100644 --- a/platform/linux-generic/include/odp/time.h +++ b/platform/linux-generic/include/odp/time.h @@ -19,13 +19,7 @@ extern "C" { #include -/** @ingroup odp_system - * @{ - */ -/** - * @} - */ #include