From patchwork Wed Apr 19 22:12:38 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97686 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524692qgf; Wed, 19 Apr 2017 15:12:54 -0700 (PDT) X-Received: by 10.55.27.18 with SMTP id b18mr4122909qkb.142.1492639974890; Wed, 19 Apr 2017 15:12:54 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id r22si3810341qtb.76.2017.04.19.15.12.54; Wed, 19 Apr 2017 15:12:54 -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 97A5562E2D; Wed, 19 Apr 2017 22:12:54 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 197B462E3F; Wed, 19 Apr 2017 22:12:52 +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 BFB3462E31; Wed, 19 Apr 2017 22:12:50 +0000 (UTC) Received: from mail-yw0-f178.google.com (mail-yw0-f178.google.com [209.85.161.178]) by lists.linaro.org (Postfix) with ESMTPS id A5FF462D27 for ; Wed, 19 Apr 2017 22:12:48 +0000 (UTC) Received: by mail-yw0-f178.google.com with SMTP id 203so24020367ywe.0 for ; Wed, 19 Apr 2017 15:12:48 -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=ZwU2dstmYOIctA2HoN0zmXkm510NAB+3LPi1D7uoSxgcSvuw+bjOZxLkP2nxfpJl46 b6NhpKQpNuw68EV93lGCU6cunxyieqdhHnQi8lADPMSBS2jBp0Bh5x9prmDwtGPDBr7f m8WOvfBFpBQ+tqYzPvDUn4PSRyLzkCjJAZ/GjXFfxNTjdZHX2TLkxW6+pDQ+E1oiI5pd FaMPl6YE/tnhSXgpLqBChY03WbKzIXEgxRoeQ5adbFDn14uo0mL6QGsIzC4JZM1gkIcG Xhwm/qiZ3gVAiCmplbU+K9AI9bNdgf09U6Gu4UkRrMdCfGNtVIuhDTCkGPx4XGN0ABdR LT8Q== X-Gm-Message-State: AN3rC/53R13gsEM0a3tHkJS11l6u3V0WrK8VCCVKXAf11jzKw6/IL22l lOmJdpBEdurcdkeRKpzODzYy X-Received: by 10.157.48.50 with SMTP id d47mr554444otc.161.1492639967748; Wed, 19 Apr 2017 15:12:47 -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 d23sm1708625oic.26.2017.04.19.15.12.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:12:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:12:38 -0500 Message-Id: <1492639961-2339-2-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> References: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [PATCH 2/5] 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;