From patchwork Wed Jul 12 01:45: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: 107434 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp207728qge; Tue, 11 Jul 2017 18:46:21 -0700 (PDT) X-Received: by 10.55.153.4 with SMTP id b4mr3255403qke.203.1499823981754; Tue, 11 Jul 2017 18:46:21 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499823981; cv=none; d=google.com; s=arc-20160816; b=AdWo5DFLS/CbCrbWhRxtlilRFE+HWYTFGNFlYxBODCPAsLrKuPIL/OA2PlOGGIsbm4 MnIMwkA9Gr2KfEne1zikBOSRSJ2wvREJU6oYFAz2pgwj0Mgx12hLSjroapVJiC/ETe8q 2O72vtbWZERsIxwGgAVSDfbM/HD1AOHFoS5c6ABV7GBvcG5AgJfUF8G13+iVXFaFW+74 AMFV7+HKno5V+8Kb2jFBqUw5cyk9XpVqU1gAEGJeJpM9Ohm/NUOuE/u9xX7yATdMujNG Xm9pqjbz6GP4BP/r5KZDgpjBBvFj+i4eJ0b+WdAKvVsDKWvsx58IscpzKgGK9s7aoJWP M/LQ== 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=aKLRwV3o5C0VsVsz4NxkURycMjHl7hFSxUhQcYKKbJA=; b=nL1JLWFzTDGRFFlSO4oJz+X6wFdi5ZJJNzla/J7c8g2sRX8sfFDxpscpy33NOm9ZAw 9CXZjlaX96QF8L3s4vlgA1vujbPNeg3N56M232melBLVc+1qYhuhBaiu327Znah2ANuH mRRRJT0RSe7rwXlL5em6KWE4lbx2aAu6qoWQXu0iSsiUGZ9O11w1RsasWmftoYQgKuD5 oMd3FQbisTzE7CyBYYAIAqWb8TLvbdNxzGDrZXTnQmSQyxuH6eiQFhcrvx1vEYhUMVKM JG86j5s4MIzLWSv+7uuVdYn+3zG3HuvsJFlYjuhtyX8nKcRsw1MjPD3FzBQhNEhspEZI xW6g== 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 x16si957930qta.307.2017.07.11.18.46.21; Tue, 11 Jul 2017 18:46:21 -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 7C73862D19; Wed, 12 Jul 2017 01:46:21 +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 74CA864478; Wed, 12 Jul 2017 01:45: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 6762F62CE7; Wed, 12 Jul 2017 01:45:50 +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 2B5E262CE7 for ; Wed, 12 Jul 2017 01:45:49 +0000 (UTC) Received: by mail-oi0-f43.google.com with SMTP id p188so8153616oia.0 for ; Tue, 11 Jul 2017 18:45:49 -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=aKLRwV3o5C0VsVsz4NxkURycMjHl7hFSxUhQcYKKbJA=; b=Hb8K/hoRW94kgg3zPTWQJHGIudmIs9jgCZQ8iuUp9zOGz/kQPNgpIZqmfKwEuzzlyI WMkU3Bf/cBtUzHHgIH0f5CxzVRN9oYZZyIcdrWCnbKQmaVZoGWlHeb68V746FGjkNTLL vaGzo8YuLQE5LFUOuIpmokBCKGXQY0Tdqwn87znU+Z2hXDtTpiDA4fqoYHPXYZjSyxWr 1z9woR7CwIkS5CDlrg6b2hj7/cMas0HQhD+ou0KAATrHqKL7J/YczdkK3eoc0jqpqoUD 3Zty0QRTZSHjNVHkfpENGwyd4Z0wuK3ONkmSZOjW8EGdVDewHRNd4EACwgk3ZWO5WF+o DMKA== X-Gm-Message-State: AIVw111qEXKbEFF/LvFspgHwlvB/bzby30z2BvSshR3VWLn4i4aZlKnG +fXBXHIZ1o/Ci2d0WD5lCmsw X-Received: by 10.202.230.212 with SMTP id d203mr2250750oih.143.1499823948491; Tue, 11 Jul 2017 18:45:48 -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.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:42 -0500 Message-Id: <20170712014545.13325-2-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 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 b31b6aa8..10bcbd51 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -164,7 +164,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; @@ -178,6 +180,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. @@ -203,6 +207,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;