From patchwork Mon Apr 13 21:05:08 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 47135 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f199.google.com (mail-wi0-f199.google.com [209.85.212.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id C351D20553 for ; Mon, 13 Apr 2015 21:06:02 +0000 (UTC) Received: by wiun10 with SMTP id n10sf12835483wiu.1 for ; Mon, 13 Apr 2015 14:06:02 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to: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=P92H3tEQ64UJIItt5bH9xBwcJflGtKEZ7isnt4Plb2s=; b=C4ouXf5plhXrMXa0HhI5vOHa+1jHNr/hWKx9otbo7S+isM03BxIwxfHI5qg128JGwg EXLbKHqbFxz/I/nk4rdYSveA4RE042VGOK7wU4Fd4+5J28IGKnBqfPUqvsfGKIe51BGV +VqdnD93fG9j8HMEIF6hMyGt1tgLoAnm/fc+GrtH1YOi70PlIlnNFlhJNzd75XOPcyxu MpIUx7ucuE7Z7drFionAebC+dQUgzSlK8DljBu6pchBOxCT+O0SFkIEIM+ZBnb4DP4f6 kR2MhtFPecAxSqU2XmKyS/kkkg0rqiEsxhCvDLlQOPTPR1M2uFhMo5jxyaeiQZZTw2Fv 5s8Q== X-Gm-Message-State: ALoCoQkn2sglra240RWtUGZgSkAa1dM6N56ugx0yUSRehQZJMGh+LqK0Q5/1o3uajpbRdY4mNvhm X-Received: by 10.194.71.227 with SMTP id y3mr2708225wju.3.1428959161962; Mon, 13 Apr 2015 14:06:01 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.234.236 with SMTP id uh12ls766794lac.54.gmail; Mon, 13 Apr 2015 14:06:01 -0700 (PDT) X-Received: by 10.152.43.225 with SMTP id z1mr14303723lal.53.1428959161766; Mon, 13 Apr 2015 14:06:01 -0700 (PDT) Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com. [209.85.217.179]) by mx.google.com with ESMTPS id x10si9309050lbo.118.2015.04.13.14.06.01 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 13 Apr 2015 14:06:01 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.179 as permitted sender) client-ip=209.85.217.179; Received: by lbbzk7 with SMTP id zk7so69535838lbb.0 for ; Mon, 13 Apr 2015 14:06:01 -0700 (PDT) X-Received: by 10.152.87.204 with SMTP id ba12mr15338751lab.35.1428959161674; Mon, 13 Apr 2015 14:06:01 -0700 (PDT) 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.67.65 with SMTP id l1csp1447760lbt; Mon, 13 Apr 2015 14:06:01 -0700 (PDT) X-Received: by 10.140.41.169 with SMTP id z38mr20188391qgz.56.1428959160455; Mon, 13 Apr 2015 14:06:00 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id a78si12209886qka.120.2015.04.13.14.05.59; Mon, 13 Apr 2015 14:06:00 -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; Received: by lists.linaro.org (Postfix, from userid 109) id B969961D89; Mon, 13 Apr 2015 21:05:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-0.7 required=5.0 tests=RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 535AD61D84; Mon, 13 Apr 2015 21:05:23 +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 DCA7E61D7E; Mon, 13 Apr 2015 21:05:15 +0000 (UTC) Received: from mail-qk0-f173.google.com (mail-qk0-f173.google.com [209.85.220.173]) by lists.linaro.org (Postfix) with ESMTPS id 62A2861D64 for ; Mon, 13 Apr 2015 21:05:15 +0000 (UTC) Received: by qkx62 with SMTP id 62so199642080qkx.0 for ; Mon, 13 Apr 2015 14:05:15 -0700 (PDT) X-Received: by 10.55.19.80 with SMTP id d77mr33281404qkh.92.1428959114733; Mon, 13 Apr 2015 14:05:14 -0700 (PDT) Received: from mike-desktop.?.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id n83sm6662893qkh.31.2015.04.13.14.05.13 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 13 Apr 2015 14:05:14 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 13 Apr 2015 17:05:08 -0400 Message-Id: <1428959108-11089-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH v2] example: doxygen: remove examples from src path X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 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" X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@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.217.179 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 If the examples are on the src path they pollute the documentation with their own declarations. The correct mechanism is to declare the examples to be seen in the documentation in one location that is on the .dox path, and have the EXAMPLE_PATH locate the actual example code. Signed-off-by: Mike Holmes --- v2 add copyright note this patch assumes that the l2fwd application has migrated to test/performance and that the ipsec which is currently not visible as an example will do the same. doc/doxygen.cfg | 2 +- doc/examples.dox | 18 ++++++++++++++++++ example/generator/odp_generator.c | 6 ------ example/packet/odp_pktio.c | 6 ------ example/timer/odp_timer_test.c | 6 ------ 5 files changed, 19 insertions(+), 19 deletions(-) create mode 100644 doc/examples.dox diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index 52c83a9..34a1000 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -10,7 +10,7 @@ TYPEDEF_HIDES_STRUCT = NO EXTRACT_STATIC = YES SORT_MEMBER_DOCS = NO WARN_NO_PARAMDOC = YES -INPUT = $(SRCDIR)/doc $(SRCDIR)/doc/users-guide $(SRCDIR)/include $(SRCDIR)/platform/linux-generic/include/odp $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp $(SRCDIR)/helper/include $(SRCDIR)/example/packet $(SRCDIR)/example/l2fwd $(SRCDIR)/example/generator $(SRCDIR)/example/timer +INPUT = $(SRCDIR)/doc $(SRCDIR)/doc/users-guide $(SRCDIR)/include $(SRCDIR)/platform/linux-generic/include/odp $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp $(SRCDIR)/helper/include FILE_PATTERNS = *.h odp*.c *.dox RECURSIVE = YES SOURCE_BROWSER = YES diff --git a/doc/examples.dox b/doc/examples.dox new file mode 100644 index 0000000..b72ee0d --- /dev/null +++ b/doc/examples.dox @@ -0,0 +1,18 @@ +/* Copyright (c) 2015, Linaro Limited + * All rights reserved. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@example odp_generator.c +ODP loopback demo application +*/ +/** +@example odp_pktio.c +ODP basic packet IO loopback test application +*/ +/** +@example odp_timer_test.c +ODP timer example application +*/ diff --git a/example/generator/odp_generator.c b/example/generator/odp_generator.c index 2ac0b47..8ae5b29 100644 --- a/example/generator/odp_generator.c +++ b/example/generator/odp_generator.c @@ -4,12 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ -/** - * @file - * - * @example odp_generator.c ODP loopback demo application - */ - /** enable strtok */ #define _POSIX_C_SOURCE 200112L diff --git a/example/packet/odp_pktio.c b/example/packet/odp_pktio.c index 61af855..f08d9f4 100644 --- a/example/packet/odp_pktio.c +++ b/example/packet/odp_pktio.c @@ -4,12 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ -/** - * @file - * - * @example odp_pktio.c ODP basic packet IO loopback test application - */ - #include #include #include diff --git a/example/timer/odp_timer_test.c b/example/timer/odp_timer_test.c index 6b60ec4..acac580 100644 --- a/example/timer/odp_timer_test.c +++ b/example/timer/odp_timer_test.c @@ -4,12 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */ -/** - * @file - * - * @example odp_timer_test.c ODP timer example application - */ - #include #include