From patchwork Wed Apr 19 22:34:42 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97692 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530761qgf; Wed, 19 Apr 2017 15:35:05 -0700 (PDT) X-Received: by 10.200.4.22 with SMTP id v22mr5035518qtg.227.1492641305113; Wed, 19 Apr 2017 15:35:05 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id m26si3855105qtb.229.2017.04.19.15.35.04; Wed, 19 Apr 2017 15:35:05 -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 54012635FE; Wed, 19 Apr 2017 22:34:58 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 1E859635DC; Wed, 19 Apr 2017 22:34:56 +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 482FA62E15; Wed, 19 Apr 2017 22:34:52 +0000 (UTC) Received: from mail-yw0-f176.google.com (mail-yw0-f176.google.com [209.85.161.176]) by lists.linaro.org (Postfix) with ESMTPS id 2F87262CE5 for ; Wed, 19 Apr 2017 22:34:50 +0000 (UTC) Received: by mail-yw0-f176.google.com with SMTP id k13so26991909ywk.1 for ; Wed, 19 Apr 2017 15:34:50 -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=o4FKVNZt44tK1qBugj9HSNMaFYyTIrla+DDnxhJQEgs=; b=h3v115gVvmoMaKLA7Z1mIFtt1NUstFGRU70fxd9rmqSAMhBkKXe2jCDiLaAtysu7M3 3+rjEVNpcwoqKSZvTCN9bfbJorhcT1GVB8KyMX0fwI0u91Ss/0Hw1HYegYGprpmWaU9K GrIdCngoHvMnnIi/bkxb4PkbCluvEq5c4vjnn+9Be+bfvpeQWSPb5MWb9oAQPUcS0wYO OS2h9AdUKo1cyis3yver4Ru8UIARzZWiWpBf5lnehyF4Zcy6uqBAYKclyx3jeI/cUBr7 z8hyYq4lNcl+Y2sZ2w4E5u0ch333ncNerovQySE6UjFGgbWPpn1S45x6f+iQBmwyQ+yj ZtOg== X-Gm-Message-State: AN3rC/7UKhKDHltFg32ZYWep4XrJf8CINO/+EC7dErc56cJDyObKmHxy NfyNDfsH1G+H3Zeltis= X-Received: by 10.157.21.17 with SMTP id u17mr2498750otf.43.1492641289813; Wed, 19 Apr 2017 15:34:49 -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 w201sm37138oiw.13.2017.04.19.15.34.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:49 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:42 -0500 Message-Id: <1492641285-7020-3-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> References: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv2 3/6] api: pool: 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 --- include/odp/api/spec/pool.h | 6 ++++++ 1 file changed, 6 insertions(+) -- 2.11.0 diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h index c0de195a..6fc5b6b4 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -166,7 +166,9 @@ typedef struct odp_pool_param_t { /** Pool type */ int type; + /** Variant parameters for different pool types */ union { + /** Parameters for buffer pools */ struct { /** Number of buffers in the pool */ uint32_t num; @@ -180,6 +182,8 @@ typedef struct odp_pool_param_t { Default will always be a multiple of 8. */ uint32_t align; } buf; + + /** Parameters for packet pools */ struct { /** The number of packets that the pool must provide that are packet length 'len' bytes or smaller. @@ -211,6 +215,8 @@ typedef struct odp_pool_param_t { Specify as 0 if no user area is needed. */ uint32_t uarea_size; } pkt; + + /** Parameters for timeout pools */ struct { /** Number of timeouts in the pool */ uint32_t num;