From patchwork Wed Apr 19 22:34:41 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97691 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530725qgf; Wed, 19 Apr 2017 15:34:58 -0700 (PDT) X-Received: by 10.200.49.61 with SMTP id g58mr5428686qtb.151.1492641298467; Wed, 19 Apr 2017 15:34:58 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 14si3857419qtp.215.2017.04.19.15.34.58; Wed, 19 Apr 2017 15:34:58 -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 8A0C162F99; Wed, 19 Apr 2017 22:34:55 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 5DE3A62E21; Wed, 19 Apr 2017 22:34: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 81F1362D27; Wed, 19 Apr 2017 22:34:51 +0000 (UTC) Received: from mail-yw0-f173.google.com (mail-yw0-f173.google.com [209.85.161.173]) by lists.linaro.org (Postfix) with ESMTPS id 69E2862C5A for ; Wed, 19 Apr 2017 22:34:49 +0000 (UTC) Received: by mail-yw0-f173.google.com with SMTP id u70so27237803ywe.2 for ; Wed, 19 Apr 2017 15:34: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=2LSYLzhs53BpXiwesbHaFuzmEbom8ZGFydXjvlbP91E=; b=UVfnY1CQY6xYvyarSzbEeKDMggvYYdsP7qQr7yn/8Vk7n9r9THGYzF2EbI7DPUu/FW lpvsgVbVMCEkcqdVCX9agxZ+wYjGarHWy3llo8Sa+I5tUxyBqXtWugni+MMuqMLXnHaH MVFCwq5E6ThE644rT129mqWsKEdY2I/DYEkgAfwkJS/C0H23iIh1NlTrZ+3h0LQioSep g5RbqdNxW8206YRibkdBDmA3KMUvZfZamszL8q9mLLJxR8FV+dJ0HMWqYLcLlexu/luz qpEdCOpKkilp5i+F19ES5IPVVK16TH0EqtvVYjg3030rbBTf4BHVKwIMDRGb1HctjEOE FpiQ== X-Gm-Message-State: AN3rC/7w32mNODzZ7XfdGYzRvn9Z8O6JXpBnIJctD9+IPRPN0VHcnrjd Yd5i8XUvmU7iwZxDXnc= X-Received: by 10.157.56.23 with SMTP id i23mr2745921otc.155.1492641289000; 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.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:48 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:41 -0500 Message-Id: <1492641285-7020-2-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 2/6] api: ipsec: 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/ipsec.h | 5 +++++ 1 file changed, 5 insertions(+) -- 2.11.0 Reviewed-by: Dmitry Eremin-Solenikov diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h index a0ceb11a..3521d2f8 100644 --- a/include/odp/api/spec/ipsec.h +++ b/include/odp/api/spec/ipsec.h @@ -157,6 +157,7 @@ typedef struct odp_ipsec_inbound_config_t { /** Flags to control IPSEC payload data checks up to the selected parse * level. */ union { + /** Mapping for individual bits */ struct { /** Check IPv4 header checksum in IPSEC payload. * Default value is 0. */ @@ -195,6 +196,7 @@ typedef struct odp_ipsec_outbound_config_t { * metadata flag to disable checksum insertion per packet bases. */ union { + /** Mapping for individual bits */ struct { /** Insert IPv4 header checksum on the payload packet * before IPSEC transformation. Default value is 0. */ @@ -393,6 +395,7 @@ typedef struct odp_ipsec_tunnel_param_t { /** Tunnel type: IPv4 or IPv6 */ odp_ipsec_tunnel_type_t type; + /** Variant mappings for tunnel parameters */ union { /** IPv4 header parameters */ struct { @@ -850,6 +853,7 @@ typedef struct odp_ipsec_op_opt_t { /** IPSEC operation status */ typedef struct odp_ipsec_op_status_t { + /** Variant mappings for op status */ union { /** Error flags */ struct { @@ -901,6 +905,7 @@ typedef struct odp_ipsec_op_status_t { uint32_t all_error; }; + /** Variant mappings for status flags */ union { /** Status flags */ struct {