From patchwork Fri Apr 21 14:25:24 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97913 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp336217obc; Fri, 21 Apr 2017 07:27:50 -0700 (PDT) X-Received: by 10.55.65.133 with SMTP id o127mr13086197qka.71.1492784870855; Fri, 21 Apr 2017 07:27:50 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id n23si9686838qkl.68.2017.04.21.07.27.50; Fri, 21 Apr 2017 07:27:50 -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; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 854AA60964; Fri, 21 Apr 2017 14:27:50 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, RCVD_IN_SORBS_SPAM, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 7EB7B61CA5; Fri, 21 Apr 2017 14:25:50 +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 44B9D60A02; Fri, 21 Apr 2017 14:25:37 +0000 (UTC) Received: from mail-oi0-f48.google.com (mail-oi0-f48.google.com [209.85.218.48]) by lists.linaro.org (Postfix) with ESMTPS id 3B19B6068A for ; Fri, 21 Apr 2017 14:25:33 +0000 (UTC) Received: by mail-oi0-f48.google.com with SMTP id s131so10845286oia.3 for ; Fri, 21 Apr 2017 07:25:33 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=Mlke+rVLUHQUHqAIpccnHiMhcy7NqhnejWjyHR5Kdl0=; b=eZjMHQUyFOPgjqnM+tTyqH/0aeug9sCQejflnJWJS4znUnmJoqM7qLVAkyP77XuV/A bGp8/SE47OZMSOmAjsB+dMXeotNPGEj8d4ak9DDXH8lH5vHCkEC3Kzgot6Hmp7NCHpPy Bah0fzWk0ReFl/lAbVeOjViryJYkQ7ULAY++8TeScGwW5B0Dyy+fSKB+VQ0vX5d6+jlp AwWOhUJh4+iAh0Hamcbr+it8fOScCFalKtCcjd2YRI3aMD71kz5u3B+04zPd4UKeQoCA rgq3ZaoYeRq8ZBo8ZiPmaiZGbSxaDE+WoAR1sCEYL37o1DwXxh3pL0zhkHN0mFJPHFec k2jw== X-Gm-Message-State: AN3rC/7xi7nFNr/UQt36VxLJZabXpUc7E8DxaG8+DVhD9OCVc2VoQkzd kpU3jySiEllE7E6MMms= X-Received: by 10.157.68.146 with SMTP id v18mr7996060ote.128.1492784732628; Fri, 21 Apr 2017 07:25:32 -0700 (PDT) Received: from localhost.localdomain (cpe-70-121-83-241.austin.res.rr.com. [70.121.83.241]) by smtp.gmail.com with ESMTPSA id z9sm4103192otd.44.2017.04.21.07.25.31 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:32 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:24 -0500 Message-Id: <1492784725-31626-5-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> References: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv3 5/6] linux-generic: types: add additional doxygen documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Resolve Bug https://bugs.linaro.org/show_bug.cgi?id=2952 by adding additional field documentation to avoid problems with doxygen 1.8.13 and higher. Signed-off-by: Bill Fischofer --- platform/linux-generic/include/odp/api/debug.h | 8 ++++++++ platform/linux-generic/include/odp/api/plat/packet_types.h | 1 + platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) -- 2.11.0 diff --git a/platform/linux-generic/include/odp/api/debug.h b/platform/linux-generic/include/odp/api/debug.h index b0f91b1c..bef2fd0e 100644 --- a/platform/linux-generic/include/odp/api/debug.h +++ b/platform/linux-generic/include/odp/api/debug.h @@ -25,17 +25,23 @@ extern "C" { * versions. */ #define _odp_merge(a, b) a##b +/** @internal */ #define _odp_label(a) _odp_merge(_ODP_SASSERT_, a) +/** @internal */ #define _ODP_SASSERT _odp_label(__COUNTER__) +/** @internal */ #define _ODP_SASSERT_ENUM(e) { _ODP_SASSERT = 1 / !!(e) } +/** @internal */ #define _odp_static_assert(e, s) enum _ODP_SASSERT_ENUM(e) #if defined(__clang__) #if defined(__cplusplus) #if !__has_feature(cxx_static_assert) && !defined(static_assert) +/** @internal */ #define static_assert(e, s) _odp_static_assert(e, s) #endif #elif !__has_feature(c_static_assert) && !defined(_Static_assert) +/** @internal */ #define _Static_assert(e, s) _odp_static_assert(e, s) #endif @@ -44,9 +50,11 @@ extern "C" { (__GNUC__ < 6 && defined(__cplusplus)) #if defined(__cplusplus) #if !defined(static_assert) +/** @intenral */ #define static_assert(e, s) _odp_static_assert(e, s) #endif #elif !defined(_Static_assert) +/** @internal */ #define _Static_assert(e, s) _odp_static_assert(e, s) #endif #endif diff --git a/platform/linux-generic/include/odp/api/plat/packet_types.h b/platform/linux-generic/include/odp/api/plat/packet_types.h index 7403afc1..a209c759 100644 --- a/platform/linux-generic/include/odp/api/plat/packet_types.h +++ b/platform/linux-generic/include/odp/api/plat/packet_types.h @@ -105,6 +105,7 @@ typedef union { /** All input flags */ uint64_t all; + /** Individual input flags */ struct { uint64_t dst_queue:1; /**< Dst queue present */ diff --git a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h index b766afec..f47a13f6 100644 --- a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h +++ b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h @@ -168,7 +168,7 @@ typedef odp_tm_handle_t odp_tm_wred_t; */ #define ODP_TM_ROOT ((odp_tm_handle_t)-1) -/** Get printable format of odp_queue_t */ +/** @internal Get printable format of odp_tm_handle_t @param hdl @return */ static inline uint64_t odp_tm_handle_to_u64(odp_tm_handle_t hdl) { return hdl;