From patchwork Thu Apr 17 10:51:13 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Uvarov X-Patchwork-Id: 28531 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ve0-f199.google.com (mail-ve0-f199.google.com [209.85.128.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id A6CC6206A6 for ; Thu, 17 Apr 2014 10:51:33 +0000 (UTC) Received: by mail-ve0-f199.google.com with SMTP id jy13sf852407veb.6 for ; Thu, 17 Apr 2014 03:51:33 -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:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=AGG5FsG0prvtfrDTD0DfznFLMOjjZLxyQpa7FAimJq0=; b=j0tZLIcm7SLupVx7/O+h8/FNWxXRUypmxOMsjcakcAnMwvSNSes9npWdinPt/SBSh0 DxP7kUwVSHF+kH/bcW/teTcyzuHtsQVbhDbhPeMnwZkhjrJ4hKRVj+3wKKYR8MS7YnKl FpXtp9zwtZoxPJB9dACmmb+o+z2bXWFbdxf/c87w4nUl6os3AmD2ApXIC+DB2mvr7RBz 9gbe/Tb8xqtN4cFsNdylHU+w9gx02Z52h0BDqb/4F5gyytCQnKsWRzrAEWfIZ8/62Vql blsGN9Z70p/RiWTDZ02+qlwGVXOGfvbcYea6cod4Jc4vZq5MGfSyzWIcaezfHRdO8i3w Vk8g== X-Gm-Message-State: ALoCoQnLk+opQGHjsDQLMstaufIkeZoVFPmdtBLdB8PeUk5oJ2DaoSTGsXGFhSbBOXcFZ0vHsTDM X-Received: by 10.236.130.101 with SMTP id j65mr2154506yhi.29.1397731893339; Thu, 17 Apr 2014 03:51:33 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.34.233 with SMTP id l96ls1034861qgl.90.gmail; Thu, 17 Apr 2014 03:51:33 -0700 (PDT) X-Received: by 10.58.185.145 with SMTP id fc17mr11515590vec.14.1397731893247; Thu, 17 Apr 2014 03:51:33 -0700 (PDT) Received: from mail-vc0-f180.google.com (mail-vc0-f180.google.com [209.85.220.180]) by mx.google.com with ESMTPS id vd8si4376541vdc.34.2014.04.17.03.51.33 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 17 Apr 2014 03:51:33 -0700 (PDT) Received-SPF: neutral (google.com: 209.85.220.180 is neither permitted nor denied by best guess record for domain of patch+caf_=patchwork-forward=linaro.org@linaro.org) client-ip=209.85.220.180; Received: by mail-vc0-f180.google.com with SMTP id lf12so296525vcb.11 for ; Thu, 17 Apr 2014 03:51:33 -0700 (PDT) X-Received: by 10.52.108.164 with SMTP id hl4mr5973390vdb.25.1397731893155; Thu, 17 Apr 2014 03:51:33 -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.220.221.72 with SMTP id ib8csp25026vcb; Thu, 17 Apr 2014 03:51:32 -0700 (PDT) X-Received: by 10.224.131.67 with SMTP id w3mr11571199qas.32.1397731892772; Thu, 17 Apr 2014 03:51:32 -0700 (PDT) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id s6si10330820qaj.223.2014.04.17.03.51.31 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 17 Apr 2014 03:51:32 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1WajuZ-00054J-OA; Thu, 17 Apr 2014 10:51:19 +0000 Received: from mail-la0-f45.google.com ([209.85.215.45]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1WajuT-00054E-1M for lng-odp@lists.linaro.org; Thu, 17 Apr 2014 10:51:13 +0000 Received: by mail-la0-f45.google.com with SMTP id hr17so232557lab.32 for ; Thu, 17 Apr 2014 03:51:18 -0700 (PDT) X-Received: by 10.152.19.65 with SMTP id c1mr2016842lae.35.1397731878708; Thu, 17 Apr 2014 03:51:18 -0700 (PDT) Received: from localhost.localdomain ([81.200.0.212]) by mx.google.com with ESMTPSA id i2sm13134134lbc.24.2014.04.17.03.51.17 for (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 17 Apr 2014 03:51:17 -0700 (PDT) From: Maxim Uvarov To: lng-odp@lists.linaro.org Date: Thu, 17 Apr 2014 14:51:13 +0400 Message-Id: <1397731873-10949-1-git-send-email-maxim.uvarov@linaro.org> X-Mailer: git-send-email 1.8.5.1.163.gd7aced9 Subject: [lng-odp] [PATCH] clean up doxygen warnings and remove warn prints for examples 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: maxim.uvarov@linaro.org X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: 209.85.220.180 is neither permitted nor denied by best guess record for domain of patch+caf_=patchwork-forward=linaro.org@linaro.org) 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 There is no need to print doxygen warnings for examples or tests. Do not print them. Signed-off-by: Maxim Uvarov --- platform/linux-generic/Makefile | 4 +++- test/api_test/odp_common.h | 5 +++-- test/api_test/odp_ring_test.c | 2 +- test/api_test/odp_shm_test.h | 1 + test/api_test/odp_timer_ping.c | 3 ++- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/platform/linux-generic/Makefile b/platform/linux-generic/Makefile index 15e2a2c..dda9fc1 100644 --- a/platform/linux-generic/Makefile +++ b/platform/linux-generic/Makefile @@ -114,7 +114,9 @@ Doxyfile: Doxyfile.in .PHONY: docs docs: $(DOC_DIR) Doxyfile ./include/odp*.h - doxygen + @echo -n "Generating Doxygen documentation... " + @doxygen 2>&1 |grep -v -e '/test/.*warning:' || true + @echo "DONE." .PHONY: docs_install docs_install: docs diff --git a/test/api_test/odp_common.h b/test/api_test/odp_common.h index f5183e1..370a9ec 100644 --- a/test/api_test/odp_common.h +++ b/test/api_test/odp_common.h @@ -24,9 +24,10 @@ typedef enum { ODP_MAX_TEST } odp_test_case_e; +/** private */ typedef struct { - int testcase; /* specifies which set of API's to exercise */ - int numthrds; /* no of pthreads to create */ + int testcase; /**< specifies which set of API's to exercise */ + int numthrds; /**< no of pthreads to create */ } pthrd_arg; extern void odp_print_system_info(void); diff --git a/test/api_test/odp_ring_test.c b/test/api_test/odp_ring_test.c index 6c2642e..ba2d57c 100644 --- a/test/api_test/odp_ring_test.c +++ b/test/api_test/odp_ring_test.c @@ -346,7 +346,7 @@ static void test_ring_stress(stress_type_t type) } } -/* local struct for ring_thread argument */ +/** @private local struct for ring_thread argument */ typedef struct { pthrd_arg thrdarg; int stress_type; diff --git a/test/api_test/odp_shm_test.h b/test/api_test/odp_shm_test.h index 3b3f49b..7b504f2 100644 --- a/test/api_test/odp_shm_test.h +++ b/test/api_test/odp_shm_test.h @@ -13,6 +13,7 @@ #ifndef ODP_SHM_TEST_H #define ODP_SHM_TEST_H +/** @private */ typedef struct { int foo; int bar; diff --git a/test/api_test/odp_timer_ping.c b/test/api_test/odp_timer_ping.c index 8b297d8..63ef619 100644 --- a/test/api_test/odp_timer_ping.c +++ b/test/api_test/odp_timer_ping.c @@ -44,6 +44,7 @@ static odp_timer_t test_timer_ping; static odp_timer_tmo_t test_ping_tmo; #define PKTSIZE 64 +/** @private packet struct */ struct packet { struct icmphdr hdr; char msg[PKTSIZE-sizeof(struct icmphdr)]; @@ -54,7 +55,7 @@ struct protoent *proto; struct sockaddr_in dst_addr; -/* local struct for ping_timer_thread argument */ +/** local struct for ping_timer_thread argument */ typedef struct { pthrd_arg thrdarg; int result;