From patchwork Mon Feb 23 17:44:29 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 44907 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 07F0521562 for ; Mon, 23 Feb 2015 17:45:00 +0000 (UTC) Received: by lbiw7 with SMTP id w7sf13391778lbi.0 for ; Mon, 23 Feb 2015 09:44:58 -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=Yl9OkifF+mPU1mJoq4BHSDHEmTVHn68p8QnBAAenPC0=; b=jzAPDMId5hDAOUla0bdmLgzNWEqgWy5avy8gcnNbIDbb8e22yIkf0GeJ+BgjBNUg43 vGHLhE3wRbLKh44KHVrfyHytMzPcZGqbszXSnEprCynANFhRMIboj71xmLQOW9O4SIeZ igbZ/bTu1EmioJpOCGewI1Rx9H1/k/lcWi/EHY6Pw09aEWHbwOKosOE+BZYrEAv1l3pL kKXs+v03u+kM65u2VRi8DohV3jKfP9ZArnbxjrcHHjA2BT5sAFrgj3Kvdw3bTbr4H9WR 6ZdCuIbxqJYFkHRn9wxf4DMnNukal+1E1fHPNS+vuAAKbYUnr5Lb9fWX1S/T+zoe3jAI BAUg== X-Gm-Message-State: ALoCoQmB1dk8KjK4DOcUF79ZpoigKlzbhU+mhOv+TKVQbqvMM+xYQrPfltp2eMfrtPoxrKTaqHr2 X-Received: by 10.194.239.41 with SMTP id vp9mr1520426wjc.5.1424713498196; Mon, 23 Feb 2015 09:44:58 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.203.171 with SMTP id kr11ls520026lac.36.gmail; Mon, 23 Feb 2015 09:44:57 -0800 (PST) X-Received: by 10.152.2.227 with SMTP id 3mr10564278lax.85.1424713497963; Mon, 23 Feb 2015 09:44:57 -0800 (PST) Received: from mail-la0-f52.google.com (mail-la0-f52.google.com. [209.85.215.52]) by mx.google.com with ESMTPS id s3si17017195lag.24.2015.02.23.09.44.57 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 23 Feb 2015 09:44:57 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.52 as permitted sender) client-ip=209.85.215.52; Received: by labhs14 with SMTP id hs14so20079443lab.1 for ; Mon, 23 Feb 2015 09:44:57 -0800 (PST) X-Received: by 10.152.179.172 with SMTP id dh12mr10615520lac.76.1424713497831; Mon, 23 Feb 2015 09:44:57 -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 h5csp1413797lbj; Mon, 23 Feb 2015 09:44:57 -0800 (PST) X-Received: by 10.140.236.70 with SMTP id h67mr27013155qhc.87.1424713490172; Mon, 23 Feb 2015 09:44:50 -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 k4si29489424qai.132.2015.02.23.09.44.48 (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 23 Feb 2015 09:44:50 -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 1YPx3l-0007xk-Mx; Mon, 23 Feb 2015 17:44:45 +0000 Received: from mail-ob0-f173.google.com ([209.85.214.173]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YPx3f-0007xf-Vw for lng-odp@lists.linaro.org; Mon, 23 Feb 2015 17:44:40 +0000 Received: by mail-ob0-f173.google.com with SMTP id uy5so38104714obc.4 for ; Mon, 23 Feb 2015 09:44:34 -0800 (PST) X-Received: by 10.202.192.11 with SMTP id q11mr7722085oif.41.1424713474629; Mon, 23 Feb 2015 09:44:34 -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 p4sm21880173oif.29.2015.02.23.09.44.33 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 23 Feb 2015 09:44:34 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 23 Feb 2015 11:44:29 -0600 Message-Id: <1424713469-18702-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCHv2] example: generator: 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.52 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=1249 Signed-off-by: Bill Fischofer Reviewed-by: Mike Holmes --- example/generator/odp_generator.c | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/example/generator/odp_generator.c b/example/generator/odp_generator.c index db9e0c2..47cab6c 100644 --- a/example/generator/odp_generator.c +++ b/example/generator/odp_generator.c @@ -287,6 +287,15 @@ static odp_packet_t pack_icmp_pkt(odp_pool_t pool) return pkt; } +/** + * Create a pktio object + * + * @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. + * @warning This routine aborts if the create is unsuccessful. + */ static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool) { odp_queue_param_t qparam;