From patchwork Thu Apr 9 13:05:30 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 46943 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f200.google.com (mail-lb0-f200.google.com [209.85.217.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 7A922218D6 for ; Thu, 9 Apr 2015 13:05:47 +0000 (UTC) Received: by lbbrr5 with SMTP id rr5sf24213134lbb.3 for ; Thu, 09 Apr 2015 06:05:46 -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:cc: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=UAmJXd4a7SFAgPJsJqS7jtINkWlNq6cnTBY9uLZ334A=; b=W5j14qTZpgVxP3xS8Mbl6Tp6deyeHYNmIuU81fZTDQtPEYzmStCVHLJ++qFWDaeNHg +IjNrPnUUAwzGvxqr/yD+5jR6b73ozrb60Nlb0qy9Fhm4w9zi24OVshQx/VKzqWizHW0 foxpJmQ30VwISq2i7D5+jyPaI0cTpTFYpenVyMr5RX5D4mbMVECHJNhVmOW6R+B2aJEc gjZ6eKCALO72ZyQdStPQVecdyyRHrqAMvgMt3tJBCg8Q2XIpp5t6UtgtKn+z7kzkQhby EwSTAP2rGwa9dJC6JBEN87fYgMZyz4083oHalaSBeW0UQt5yoAIw6uCtDdFSwEzZOlut vhew== X-Gm-Message-State: ALoCoQmcQ7Jkg/NuQ9nqnPGanBl/WKBQgoQBNC6ky/GIL63jhuibcCclnyTuoqaDgLMwuky16YyX X-Received: by 10.194.53.225 with SMTP id e1mr5935385wjp.4.1428584746487; Thu, 09 Apr 2015 06:05:46 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.42.172 with SMTP id p12ls316360lal.40.gmail; Thu, 09 Apr 2015 06:05:46 -0700 (PDT) X-Received: by 10.112.120.199 with SMTP id le7mr22371846lbb.48.1428584746327; Thu, 09 Apr 2015 06:05:46 -0700 (PDT) Received: from mail-la0-f51.google.com (mail-la0-f51.google.com. [209.85.215.51]) by mx.google.com with ESMTPS id yj8si11420161lab.53.2015.04.09.06.05.46 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 09 Apr 2015 06:05:46 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.51 as permitted sender) client-ip=209.85.215.51; Received: by lagv1 with SMTP id v1so88997230lag.3 for ; Thu, 09 Apr 2015 06:05:46 -0700 (PDT) X-Received: by 10.152.163.35 with SMTP id yf3mr4399367lab.86.1428584746214; Thu, 09 Apr 2015 06:05:46 -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 l1csp460612lbt; Thu, 9 Apr 2015 06:05:45 -0700 (PDT) X-Received: by 10.55.31.218 with SMTP id n87mr56589270qkh.99.1428584744956; Thu, 09 Apr 2015 06:05:44 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id o18si14277469qkh.111.2015.04.09.06.05.44; Thu, 09 Apr 2015 06:05:44 -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 0B77565008; Thu, 9 Apr 2015 13:05:44 +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 E41A664ED0; Thu, 9 Apr 2015 13:05:40 +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 82C0C65005; Thu, 9 Apr 2015 13:05:38 +0000 (UTC) Received: from mail-qc0-f177.google.com (mail-qc0-f177.google.com [209.85.216.177]) by lists.linaro.org (Postfix) with ESMTPS id 7A31464ED0 for ; Thu, 9 Apr 2015 13:05:37 +0000 (UTC) Received: by qcyk17 with SMTP id k17so35187601qcy.1 for ; Thu, 09 Apr 2015 06:05:37 -0700 (PDT) X-Received: by 10.140.98.148 with SMTP id o20mr34965160qge.99.1428584737242; Thu, 09 Apr 2015 06:05:37 -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 m49sm9768648qgd.44.2015.04.09.06.05.36 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 09 Apr 2015 06:05:36 -0700 (PDT) From: Mike Holmes To: anders.roxell@linaro.org Date: Thu, 9 Apr 2015 09:05:30 -0400 Message-Id: <1428584730-9862-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Cc: lng-odp@lists.linaro.org Subject: [lng-odp] [PATCH] 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.215.51 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 --- doc/doxygen.cfg | 2 +- doc/examples.dox | 12 ++++++++++++ example/generator/odp_generator.c | 6 ------ example/packet/odp_pktio.c | 6 ------ example/timer/odp_timer_test.c | 6 ------ 5 files changed, 13 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..bf3d790 --- /dev/null +++ b/doc/examples.dox @@ -0,0 +1,12 @@ +/** +@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