From patchwork Wed Jul 12 01:45:44 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 107436 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp208372qge; Tue, 11 Jul 2017 18:47:10 -0700 (PDT) X-Received: by 10.200.33.209 with SMTP id 17mr3752276qtz.189.1499824030518; Tue, 11 Jul 2017 18:47:10 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499824030; cv=none; d=google.com; s=arc-20160816; b=IAZVHWDa3cW780eiLs4GlUIzi8HQT23PtgHC+5DScsn9eqVwGHmTUZlPsm2VZjSVr2 Ib9zgAPKZKtQdbQWS0OV+adHBHOIVrlliYjYGaCE3hcXCEJa8Rq0yGEJGKW/rKnMe9cj 06wGcpTwXxjKBeOrg4+iZ1X9AD352+6KApA8cNI6J8+esT5CL5Pb+puioikzxoFTnyLC VZLNyDsjmZs2aERgXwsebLsMSxr48kpd7zxA2ZjkuTQepbAnZZHtzMZsCQ1HZVfVkTA6 NnP579E0OSu1ATezkFa7jio2P2w3bD45KEihMLee/akUxr1tsqSk+qINYcZcV4zbl76E FQdg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=+zGQwTz+Z1xrv+weSKmYgpcEj6gJ9vcrCZq/u1dparU=; b=eS1fXYyNEZBzTZd6rC1HES4Lllx9CLNKnr68PFFV63HoaUqHgrM+9JhHi2iAalxTv0 pAtoYTmwhWmV+TEwXzRy0SrKM7M330Z8DRVGbMHydnmBEaV9XjUn7GWqrH2Cu4cr7Gdp PCAsx2MZESu/TD5DZU+xZUYgnnkgSXVzWER7qFRBCDb6Dax9JWB4PqgH8LnBTqPYSDHk wOgzmx0SfcdiJL9nB0WaWxO+b6nQZBcWtcUdMo4+5RBckQ0gfmNModcOWWWYWnmcMt0U nufXX7YdjyoK+2R2PSTpQRajSgvGj6w6bfrbiv3lOE88NPQ/gqFgy8vqVGBuo6hZAG1P xDEw== ARC-Authentication-Results: i=1; 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 Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id b82si1047064qkh.366.2017.07.11.18.47.10; Tue, 11 Jul 2017 18:47:10 -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 326DE64490; Wed, 12 Jul 2017 01:47:10 +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 5F4A364478; Wed, 12 Jul 2017 01:46:24 +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 DFFF162D32; Wed, 12 Jul 2017 01:46:19 +0000 (UTC) Received: from mail-oi0-f43.google.com (mail-oi0-f43.google.com [209.85.218.43]) by lists.linaro.org (Postfix) with ESMTPS id 4E46162D19 for ; Wed, 12 Jul 2017 01:45:51 +0000 (UTC) Received: by mail-oi0-f43.google.com with SMTP id p188so8154050oia.0 for ; Tue, 11 Jul 2017 18:45:51 -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=+zGQwTz+Z1xrv+weSKmYgpcEj6gJ9vcrCZq/u1dparU=; b=RxP0BVLu9pdRVUeZMY9Cj6FZd7jODlUlliz1G9iaEkHqQRAw62PlefOw6qUhB5FIeW r3/qI2TGyLyL/m9df2rLzrHEKuT5rz4y2k2D19neF2xBsvl/+B3Sh3WyyY2watUVvIgt Bvppi9VW+QMHiY5er6qiroOvsSu5GcvsdDQlImaxdmyoAn1KGPw8vGkb+e4xzn7AdTo6 t1UxtW0K5ZljA1EELtutgUmwQBTTyHmrFBFTQCwWLYyLgjA2pLZoHkZfShwwcXing7jj XdrNdjkfSkd+rXpgQ+W6yvv7ZArB55W+QVrW6f2ToeufY/sp5H5uKhqVwGcPXRu91u9e VWfg== X-Gm-Message-State: AIVw113Pl83ZklL3C9gHW4aBJRdBp5vY1C36hY3Vt+IjjyYl7GGCMvfi BZQjXm391FUBrj8f7l6Imb5A X-Received: by 10.202.58.136 with SMTP id h130mr2145674oia.159.1499823950557; Tue, 11 Jul 2017 18:45:50 -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 s129sm910041oif.41.2017.07.11.18.45.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:49 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:44 -0500 Message-Id: <20170712014545.13325-4-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712014545.13325-1-bill.fischofer@linaro.org> References: <20170712014545.13325-1-bill.fischofer@linaro.org> Subject: [lng-odp] [MONARCH_LTS PATCH 4/5] 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/plat/buffer_types.h | 11 ++++++++++- platform/linux-generic/include/odp/api/plat/pool_types.h | 11 ++++++++++- .../linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +- 3 files changed, 21 insertions(+), 3 deletions(-) -- 2.11.0 diff --git a/platform/linux-generic/include/odp/api/plat/buffer_types.h b/platform/linux-generic/include/odp/api/plat/buffer_types.h index 344121b6..079f5aaa 100644 --- a/platform/linux-generic/include/odp/api/plat/buffer_types.h +++ b/platform/linux-generic/include/odp/api/plat/buffer_types.h @@ -32,7 +32,16 @@ typedef ODP_HANDLE_T(odp_buffer_seg_t); /** Invalid segment */ #define ODP_SEGMENT_INVALID ((odp_buffer_seg_t)ODP_BUFFER_INVALID) -/** Get printable format of odp_buffer_t */ +/** Get printable format of odp_buffer_t + * + * @param hdl odp_buffer_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_buffer_t handle. + */ static inline uint64_t odp_buffer_to_u64(odp_buffer_t hdl) { return _odp_pri(hdl); diff --git a/platform/linux-generic/include/odp/api/plat/pool_types.h b/platform/linux-generic/include/odp/api/plat/pool_types.h index 1ca8f02e..c466dcbb 100644 --- a/platform/linux-generic/include/odp/api/plat/pool_types.h +++ b/platform/linux-generic/include/odp/api/plat/pool_types.h @@ -39,7 +39,16 @@ typedef enum odp_pool_type_t { ODP_POOL_TIMEOUT = ODP_EVENT_TIMEOUT, } odp_pool_type_t; -/** Get printable format of odp_pool_t */ +/** Get printable format of odp_pool_t + * + * @param hdl odp_pool_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_pool_t handle. + */ static inline uint64_t odp_pool_to_u64(odp_pool_t hdl) { return _odp_pri(hdl); 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;