From patchwork Mon Feb 23 17:18:57 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 44904 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f199.google.com (mail-lb0-f199.google.com [209.85.217.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id AB07321562 for ; Mon, 23 Feb 2015 17:19:20 +0000 (UTC) Received: by lbvp9 with SMTP id p9sf13262979lbv.1 for ; Mon, 23 Feb 2015 09:19:19 -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=UdGQGoWxuDypyagYOLuBI8V3I/n2Tj//vw8rHeVhHeg=; b=FYEtnL2X8GL5dnE8KvNkCdlp+lxcsbjym0u98eGLIcsmvIGNvN4oZYOk8BVvSgYSAy 2p85qc1dnoer3uiwPYsktyIKWJ2J6X+sYL38Wx4JUm13hLQkvFEiDMk8bKlkpfJgNXPX sISzjmxzGZooXaJ+7SbdMJtYcSxrTmq25wQE7ny3BcL5TSrKHcVkIoy0fJjGRvp0XviG alQ6nMCyo77Bha/K7xymQETBUKiJUl5NihEj7uiwOWmrpizoS5TXuO7OV6b/217aHqRT MHDjGVvo4on1X9YGXoMnK+mLH8ngbylvfeNO548o58OOkl6EG7gUX1oy5CJfW0m8ofJ0 BaFg== X-Gm-Message-State: ALoCoQn0mf369P1EJxJvNUpLrUw8Q+nJEjzUoCOY6Kr6pjpP4YMNDwYU0Di3xYQZedtjB/bUe99E X-Received: by 10.180.83.168 with SMTP id r8mr997634wiy.6.1424711959626; Mon, 23 Feb 2015 09:19:19 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.88.84 with SMTP id be20ls371172lab.89.gmail; Mon, 23 Feb 2015 09:19:19 -0800 (PST) X-Received: by 10.152.242.132 with SMTP id wq4mr10787525lac.79.1424711959461; Mon, 23 Feb 2015 09:19:19 -0800 (PST) Received: from mail-la0-f44.google.com (mail-la0-f44.google.com. [209.85.215.44]) by mx.google.com with ESMTPS id w8si10816750law.75.2015.02.23.09.19.19 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 23 Feb 2015 09:19:19 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) client-ip=209.85.215.44; Received: by labhs14 with SMTP id hs14so19912099lab.1 for ; Mon, 23 Feb 2015 09:19:19 -0800 (PST) X-Received: by 10.152.43.51 with SMTP id t19mr10577279lal.73.1424711959323; Mon, 23 Feb 2015 09:19:19 -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 h5csp1399675lbj; Mon, 23 Feb 2015 09:19:18 -0800 (PST) X-Received: by 10.140.148.195 with SMTP id 186mr67875qhu.60.1424711957908; Mon, 23 Feb 2015 09:19:17 -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 r9si36517250qcg.13.2015.02.23.09.19.16 (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 23 Feb 2015 09:19:17 -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 1YPwf3-0006QR-Ji; Mon, 23 Feb 2015 17:19:13 +0000 Received: from mail-oi0-f49.google.com ([209.85.218.49]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YPwey-0006OL-J5 for lng-odp@lists.linaro.org; Mon, 23 Feb 2015 17:19:08 +0000 Received: by mail-oi0-f49.google.com with SMTP id v63so14664281oia.8 for ; Mon, 23 Feb 2015 09:19:03 -0800 (PST) X-Received: by 10.182.209.72 with SMTP id mk8mr8038584obc.54.1424711943236; Mon, 23 Feb 2015 09:19:03 -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 fu12sm15308441oeb.14.2015.02.23.09.19.02 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 23 Feb 2015 09:19:02 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 23 Feb 2015 11:18:57 -0600 Message-Id: <1424711937-13477-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH] 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.44 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 --- 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..f2cad7c 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. 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;