From patchwork Wed Apr 19 22:34:43 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97693 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530777qgf; Wed, 19 Apr 2017 15:35:08 -0700 (PDT) X-Received: by 10.237.60.77 with SMTP id u13mr4823929qte.267.1492641308936; Wed, 19 Apr 2017 15:35:08 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id s5si3843017qkf.254.2017.04.19.15.35.08; Wed, 19 Apr 2017 15:35:08 -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 2238363664; Wed, 19 Apr 2017 22:35:00 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 75BDF635FD; Wed, 19 Apr 2017 22:34:57 +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 079A960669; Wed, 19 Apr 2017 22:34:53 +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 E5A9D61CB0 for ; Wed, 19 Apr 2017 22:34:50 +0000 (UTC) Received: by mail-yw0-f178.google.com with SMTP id k13so26992227ywk.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=YqtVwxlg1mJl6DukupnlccHE5eP0YV9plvwj9+Y4FEg=; b=kwCGTxmIMiNI2cKpaKSmRSP7gxeUQU87fnUfpdtW3BXwdDQGAzBRsIq+UpK9tE934r vcCAl2VwR031mqktrF941kkKZPlbIdOQ/Jd3ojxMmTZTNOHvJM82MniFjZ1+fI60+rH9 eEVBJY7sD7+Bn4ILMlYGM4NxjtNh7OcqfDD0LRGsQfXPM8CvGH5GOIWHaEzsnDxD+qN9 uzYeP5Wtp/KVXWCEdwWyEepl6TbmMFGtovd3NMoqCc3LTedt4bfc2kqcv1K9DY1/S9Xi ToE0uj8pDWya2w9cGh23kwoKbkvtjWpoL8XlEUtObRC7FkIWwBBOnYKVNy3DmdsXLIEy /t9w== X-Gm-Message-State: AN3rC/7eZh4ItTBp7XVhscfza7ntzR/cTA5vgQxM14vaY+clw1WZnFwD CRYZgTRVMDYp50KRvNA= X-Received: by 10.157.50.200 with SMTP id u66mr2937937otb.121.1492641290547; Wed, 19 Apr 2017 15:34:50 -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:50 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:43 -0500 Message-Id: <1492641285-7020-4-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 4/6] api: tm: 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/traffic_mngr.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) -- 2.11.0 diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h index 71198bbd..3a748cef 100644 --- a/include/odp/api/spec/traffic_mngr.h +++ b/include/odp/api/spec/traffic_mngr.h @@ -471,9 +471,10 @@ typedef enum { typedef struct { odp_tm_egress_kind_t egress_kind; /**< Union discriminator */ + /** Variant parameters for different TM outputs */ union { - odp_pktio_t pktio; - odp_tm_egress_fcn_t egress_fcn; + odp_pktio_t pktio; /**< Output to PktIO */ + odp_tm_egress_fcn_t egress_fcn; /**< Output to user func */ }; } odp_tm_egress_t;