From patchwork Fri Apr 21 14:25:22 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97911 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp335779obc; Fri, 21 Apr 2017 07:26:36 -0700 (PDT) X-Received: by 10.200.41.182 with SMTP id 51mr15306285qts.127.1492784796488; Fri, 21 Apr 2017 07:26:36 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id y19si9699961qta.24.2017.04.21.07.26.36; Fri, 21 Apr 2017 07:26:36 -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 2604562C71; Fri, 21 Apr 2017 14:26:36 +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=-1.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, 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 D01EC608B3; Fri, 21 Apr 2017 14:25:41 +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 0272E608C6; Fri, 21 Apr 2017 14:25:32 +0000 (UTC) Received: from mail-oi0-f49.google.com (mail-oi0-f49.google.com [209.85.218.49]) by lists.linaro.org (Postfix) with ESMTPS id 76B4B6068A for ; Fri, 21 Apr 2017 14:25:31 +0000 (UTC) Received: by mail-oi0-f49.google.com with SMTP id s131so10844148oia.3 for ; Fri, 21 Apr 2017 07:25:31 -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=qpuGK2FVxNbLJHp4YjvO7pTnsvUv+5DFG12nnrkcJ4g9GOGcnBCzIr8Mn+bO6v6yMs poEKMwzB8HR0LBlVTJxQyst3HjZP6RbrDrNAsF6EPP2RQf2LFwXVGeEQtbQdMy/+upfm 7+r3ZYpakpSIDZGCG9NyJRr8GrKCDS56xS3qV51U7M9IHZrEbQ9SnQoCS4eduV2n6KYW ZYJyKuQ24WKcQOSeBi0x5XszGAPhqF54jTlvPH2wr8uK60C+jZoRxBp3ABi/SqXwXASv 4oB1etKcuGCEYAitBFMO8qi6cCIMa2NC2oBNuIbKeqjCseGfT7VdOBYSRUVyyPgDu8U0 8bbw== X-Gm-Message-State: AN3rC/6yaznnKOoz0NHc8J4h8DFzYv61wPM+80Y+lpgdJsqnFY5KxMBy IxipVz7Gh5gVPZ3wLN8Kj+JN X-Received: by 10.157.63.251 with SMTP id i56mr1426518ote.54.1492784730767; Fri, 21 Apr 2017 07:25:30 -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.29 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:30 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:22 -0500 Message-Id: <1492784725-31626-3-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 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;