From patchwork Wed Apr 19 22:12:39 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97687 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524697qgf; Wed, 19 Apr 2017 15:12:56 -0700 (PDT) X-Received: by 10.200.36.2 with SMTP id c2mr4872782qtc.271.1492639976432; Wed, 19 Apr 2017 15:12:56 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q19si3804156qta.165.2017.04.19.15.12.56; Wed, 19 Apr 2017 15:12:56 -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 0CF4E62E49; Wed, 19 Apr 2017 22:12:55 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 45C5462E65; Wed, 19 Apr 2017 22:12:53 +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 2D04362E31; Wed, 19 Apr 2017 22:12:51 +0000 (UTC) Received: from mail-yw0-f169.google.com (mail-yw0-f169.google.com [209.85.161.169]) by lists.linaro.org (Postfix) with ESMTPS id F07B962D2D for ; Wed, 19 Apr 2017 22:12:48 +0000 (UTC) Received: by mail-yw0-f169.google.com with SMTP id 203so24020521ywe.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=YqtVwxlg1mJl6DukupnlccHE5eP0YV9plvwj9+Y4FEg=; b=CnTChEsGK3wjnbBqdeYQptPAGNz+DWDyzimo1p5petcwutpvCLaWMZuJ+qm2BjlQZO WlzGclbWmPoyng50UxZG1es67DuB5S1+GFo9PQDzOpyjHw4Kg7n1bEagCzm8JQFBnYmH sXxqdTLZ3xHp0LKdMnAf9eBWsQlZJ4kIW/vD0VfRo6sEL+n9rTtpqRJVtrQP+sT5Pxlo RH25Ud3K7Szt+XLbTSXS6LXORRiNdHpqn/MzU0aQ7mHm7rD00+2oM+8s5kUIpM2kPlgA 3CQHNfJWPZEqNYaAKiHYBwu2IFl2WzCPhkXcHvsMDN8aY8363J6ChWDGaBQF28NKY1YM n+HQ== X-Gm-Message-State: AN3rC/5k/R+z8XRhd3se1UOmF/zacOTkwfwicxxP1+9KVEcGSZlF+/GX 37u8OvlFSxy7oKXoGlwYTE0+ X-Received: by 10.157.25.23 with SMTP id j23mr2709778ota.9.1492639968419; Wed, 19 Apr 2017 15:12: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 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:39 -0500 Message-Id: <1492639961-2339-3-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 3/5] 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;