From patchwork Mon Feb 23 17:21:10 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 44905 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ee0-f69.google.com (mail-ee0-f69.google.com [74.125.83.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 2491821562 for ; Mon, 23 Feb 2015 17:21:34 +0000 (UTC) Received: by eekb15 with SMTP id b15sf12191376eek.0 for ; Mon, 23 Feb 2015 09:21:33 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=vS9zlTAD7zDuFGKClR3VEmV9TLfd/YVprxiqIYMLOqE=; b=K7zNUdAQUG/XaD6grAx7U6QQvdpODxBUXH6EY08pO3o3HtAdX9EAtVjdraKIKBaKAg fHIWKdwutsU28furaUQqBE/rimXJFUItmCO5ReV8vN2bKK6Fm5HQPQ7lhtw8gdE2Ha90 w0kv4eMJxgIxfKhWozJDk+0mGUYL2UsSivuvM5+C2xfji8CmVetlEaUBii4WIpi97asG hOs97oSAIzEdJNy6tNo5qvG8iHdv6WHm9UpVMK1BprWmtjQ/Sw1EOjHbJkJmQXiUqowO w7lAFAUiA+lmfKaxKbKmcAr+DtsUqDIHx63QoRn35+GS6h0z1qp8mwP6BbAxPKpo5fle w0RA== X-Gm-Message-State: ALoCoQlOCbnkoTjnHLq61z2Rm0a0WS+F+QxJZBMQXapNgQfMAYYYOOBNdn8aJAs06PyUL+XzpdQ8 X-Received: by 10.194.142.174 with SMTP id rx14mr1515015wjb.4.1424712093326; Mon, 23 Feb 2015 09:21:33 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.246.11 with SMTP id xs11ls573866lac.54.gmail; Mon, 23 Feb 2015 09:21:33 -0800 (PST) X-Received: by 10.112.159.195 with SMTP id xe3mr10865070lbb.64.1424712093166; Mon, 23 Feb 2015 09:21:33 -0800 (PST) Received: from mail-la0-f54.google.com (mail-la0-f54.google.com. [209.85.215.54]) by mx.google.com with ESMTPS id m6si24678775lbs.23.2015.02.23.09.21.33 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 23 Feb 2015 09:21:33 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) client-ip=209.85.215.54; Received: by lams18 with SMTP id s18so19911525lam.11 for ; Mon, 23 Feb 2015 09:21:33 -0800 (PST) X-Received: by 10.112.188.165 with SMTP id gb5mr10964419lbc.35.1424712093039; Mon, 23 Feb 2015 09:21:33 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.35.133 with SMTP id h5csp1400985lbj; Mon, 23 Feb 2015 09:21:32 -0800 (PST) X-Received: by 10.229.171.134 with SMTP id h6mr27268117qcz.19.1424712091849; Mon, 23 Feb 2015 09:21:31 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id e5si36512576qcm.34.2015.02.23.09.21.30 (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 23 Feb 2015 09:21:31 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YPwhE-0006Sg-8m; Mon, 23 Feb 2015 17:21:28 +0000 Received: from mail-ob0-f171.google.com ([209.85.214.171]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YPwh8-0006Sb-Lp for lng-odp@lists.linaro.org; Mon, 23 Feb 2015 17:21:22 +0000 Received: by mail-ob0-f171.google.com with SMTP id gq1so37890953obb.2 for ; Mon, 23 Feb 2015 09:21:17 -0800 (PST) X-Received: by 10.182.249.102 with SMTP id yt6mr8300496obc.30.1424712077401; Mon, 23 Feb 2015 09:21:17 -0800 (PST) Received: from localhost.localdomain (cpe-24-28-70-239.austin.res.rr.com. [24.28.70.239]) by mx.google.com with ESMTPSA id cc4sm13767672obb.13.2015.02.23.09.21.16 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 23 Feb 2015 09:21:16 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 23 Feb 2015 11:21:10 -0600 Message-Id: <1424712070-13955-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH] example: l2fwd: add missing doxygen documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: bill.fischofer@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Add missing doxygen documentation to resolve Bug https://bugs.linaro.org/show_bug.cgi?id=1250 Signed-off-by: Bill Fischofer --- example/l2fwd/odp_l2fwd.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c index 0326a3c..4b71822 100644 --- a/example/l2fwd/odp_l2fwd.c +++ b/example/l2fwd/odp_l2fwd.c @@ -240,6 +240,12 @@ static void *pktio_ifburst_thread(void *arg) /** * Create a pktio handle, optionally associating a default input queue. + * + * @param dev Name of device to open + * @param pool Pool to associate with device for packet RX/TX + * + * @return The handle of the created pktio object. + * #retval ODP_PKTIO_INVALID if the create fails. */ static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool, int mode)