From patchwork Mon Apr 20 19:55:34 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 47368 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f72.google.com (mail-la0-f72.google.com [209.85.215.72]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id A43242121F for ; Mon, 20 Apr 2015 19:55:49 +0000 (UTC) Received: by laat2 with SMTP id t2sf41711766laa.2 for ; Mon, 20 Apr 2015 12:55:48 -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=WCf9vbukoUBzO99m/A7nUM7jV00XM/hUSHuWwQbbaQc=; b=hGNYqK8hpE5lg79fmKnv/kBW3fwwETS8bMPXP2PUucrFdFsdnnqJlsRHi9Cba+RDtj 4Bz9vZBQN4O0ZLjoqUIokLXQUnRM26zFhXR4BOgZa5E2xpQLaf5sowkCuriJk4wQ/66R 8W37faHXaTFJi+2CIvQ3+rMR+RjO5Kt8GxB9lG71RJO/rm+2NKTGxf/IgZmCXC34yKFF zrI1wY1rHd49Ew1R5i50tTHXZsjWA/Vqmer4V6oC6kI6EAOUysz3ORT/i3J3sPIKfk1d pquTgk1wq7HS7hDV2WrPMu9JikIDBf9YkNjOkZKZPiEixP0W3B52MmLmYLR/ox07jD2N ja7Q== X-Gm-Message-State: ALoCoQmSSDnX0S79eAj+UW356uSLS4rhPjiqFYDeXjc3U4aeGe6Be5eIkhdSPfbKP5pn2QkptagE X-Received: by 10.112.189.131 with SMTP id gi3mr7725480lbc.6.1429559748276; Mon, 20 Apr 2015 12:55:48 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.4.73 with SMTP id i9ls857824lai.100.gmail; Mon, 20 Apr 2015 12:55:47 -0700 (PDT) X-Received: by 10.112.218.67 with SMTP id pe3mr16197838lbc.53.1429559747749; Mon, 20 Apr 2015 12:55:47 -0700 (PDT) Received: from mail-lb0-f173.google.com (mail-lb0-f173.google.com. [209.85.217.173]) by mx.google.com with ESMTPS id wu8si15688571lac.157.2015.04.20.12.55.47 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 20 Apr 2015 12:55:47 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.173 as permitted sender) client-ip=209.85.217.173; Received: by lbcga7 with SMTP id ga7so139454320lbc.1 for ; Mon, 20 Apr 2015 12:55:47 -0700 (PDT) X-Received: by 10.152.26.34 with SMTP id i2mr16764925lag.117.1429559747627; Mon, 20 Apr 2015 12:55:47 -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 l1csp221954lbt; Mon, 20 Apr 2015 12:55:46 -0700 (PDT) X-Received: by 10.140.132.80 with SMTP id 77mr20330432qhe.36.1429559745634; Mon, 20 Apr 2015 12:55:45 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id z13si20609148qkg.1.2015.04.20.12.55.44; Mon, 20 Apr 2015 12:55:45 -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 9F05E61DE9; Mon, 20 Apr 2015 19:55: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=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, 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 C9D7561DD8; Mon, 20 Apr 2015 19:55:42 +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 845D161DDF; Mon, 20 Apr 2015 19:55:41 +0000 (UTC) Received: from mail-qk0-f175.google.com (mail-qk0-f175.google.com [209.85.220.175]) by lists.linaro.org (Postfix) with ESMTPS id 75E1561DD8 for ; Mon, 20 Apr 2015 19:55:40 +0000 (UTC) Received: by qkhg7 with SMTP id g7so197411781qkh.2 for ; Mon, 20 Apr 2015 12:55:40 -0700 (PDT) X-Received: by 10.55.20.132 with SMTP id 4mr31822078qku.104.1429559740243; Mon, 20 Apr 2015 12:55:40 -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 n13sm15180478qkh.8.2015.04.20.12.55.39 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 20 Apr 2015 12:55:39 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 20 Apr 2015 15:55:34 -0400 Message-Id: <1429559734-22187-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH v3] 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.173 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 Reviewed-by: Anders Roxell --- v3 fix "*" in comments to look like all the other files doc/doxygen.cfg | 7 ++++++- doc/examples.dox | 20 ++++++++++++++++++++ example/generator/odp_generator.c | 6 ------ example/packet/odp_pktio.c | 6 ------ example/timer/odp_timer_test.c | 6 ------ 5 files changed, 26 insertions(+), 19 deletions(-) create mode 100644 doc/examples.dox diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index 4208afa..6283387 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -10,7 +10,12 @@ 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/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..2a7c597 --- /dev/null +++ b/doc/examples.dox @@ -0,0 +1,20 @@ +/* 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