From patchwork Thu Mar 20 02:32:18 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 26630 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-vc0-f197.google.com (mail-vc0-f197.google.com [209.85.220.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 6E9E8203C3 for ; Thu, 20 Mar 2014 02:32:29 +0000 (UTC) Received: by mail-vc0-f197.google.com with SMTP id if11sf565028vcb.0 for ; Wed, 19 Mar 2014 19:32:28 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:from:to:cc:subject:date:message-id :x-original-sender:x-original-authentication-results:precedence :mailing-list:list-id:list-post:list-help:list-archive :list-unsubscribe:content-type; bh=s9OZAKDfOTiGXeSsZrEu8ZRdIzLjkyw9tKv9dUr6uyQ=; b=W3XEY9XOuNfR/P5TDlB9BRE0m/ARLSEoCAtlox5ZHyiDSLsD8caH98tziKSUBnw8aJ wNLs5ibXTceQ5TnSOBV1Pm1inNDxzk0dGn3SXFU9BA45EOofXrEHE7jwkZp2f5oLvZq7 12TlM9LNxI/mFtU2vv+SDrIXO1OFML+psQRq8n8T9RfEfNC/eShsyD971elI3erQWYm3 DvbqFf3xZfRMEHRaSXTPGgdkwZr+dklKyvuLQ/DT9kW869aT5CfF4+LJEokivByaesws Lmw3aCeVvAF1pCiAIxhEsQ5u3+eQgs2O8Vlht5Nq8Z7DBQ/aGXc3Eo83+cL/OW+CXD1/ W12A== X-Gm-Message-State: ALoCoQnS6XWklMC+yiPVOk5IgwQj04xX8azLYEID8xhTCxq74U1NiOKdpaOVndgHI4rmayL7morG X-Received: by 10.236.125.6 with SMTP id y6mr8871533yhh.3.1395282748808; Wed, 19 Mar 2014 19:32:28 -0700 (PDT) MIME-Version: 1.0 X-BeenThere: lng-odp@linaro.org Received: by 10.140.97.72 with SMTP id l66ls56340qge.16.gmail; Wed, 19 Mar 2014 19:32:28 -0700 (PDT) X-Received: by 10.224.43.71 with SMTP id v7mr289923qae.92.1395282748600; Wed, 19 Mar 2014 19:32:28 -0700 (PDT) Received: from mail-qg0-f47.google.com (mail-qg0-f47.google.com [209.85.192.47]) by mx.google.com with ESMTPS id 45si225757qgg.155.2014.03.19.19.32.28 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 19 Mar 2014 19:32:28 -0700 (PDT) Received-SPF: neutral (google.com: 209.85.192.47 is neither permitted nor denied by best guess record for domain of mike.holmes@linaro.org) client-ip=209.85.192.47; Received: by mail-qg0-f47.google.com with SMTP id 63so702159qgz.6 for ; Wed, 19 Mar 2014 19:32:28 -0700 (PDT) X-Received: by 10.224.43.200 with SMTP id x8mr47378449qae.43.1395282748512; Wed, 19 Mar 2014 19:32:28 -0700 (PDT) Received: from fedora1.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id s61sm762069qge.11.2014.03.19.19.32.27 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Mar 2014 19:32:28 -0700 (PDT) From: Mike Holmes To: lng-odp@linaro.org Cc: mike-holmes Subject: [lng-odp] [PATCH] Add missing doxygen todo tags Date: Wed, 19 Mar 2014 22:32:18 -0400 Message-Id: <1395282738-10633-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: 209.85.192.47 is neither permitted nor denied by best guess record for domain of mike.holmes@linaro.org) smtp.mail=mike.holmes@linaro.org Precedence: list Mailing-list: list lng-odp@linaro.org; contact lng-odp+owners@linaro.org List-ID: X-Google-Group-Id: 474323889996 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , From: mike-holmes Signed-off-by: Mike Holmes --- include/odp_ring.h | 6 ++++-- platform/linux-generic/Doxyfile.in | 2 +- platform/linux-generic/include/odp_buffer_internal.h | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/include/odp_ring.h b/include/odp_ring.h index 7ba1ca9..134ae48 100644 --- a/include/odp_ring.h +++ b/include/odp_ring.h @@ -37,7 +37,9 @@ ***************************************************************************/ /** - * ODP Ring + * @file + * + * ODP Ring Helper * * The Ring Manager is a fixed-size queue, implemented as a table of * pointers. Head and tail pointers are modified atomically, allowing @@ -324,7 +326,7 @@ unsigned odp_ring_free_count(const odp_ring_t *r); */ odp_ring_t *odp_ring_lookup(const char *name); -/*todo: dump the status of all rings on the console */ +/**\todo: dump the status of all rings on the console */ void odp_ring_list_dump(void); #ifdef __cplusplus diff --git a/platform/linux-generic/Doxyfile.in b/platform/linux-generic/Doxyfile.in index 421e7ac..b1c46ab 100644 --- a/platform/linux-generic/Doxyfile.in +++ b/platform/linux-generic/Doxyfile.in @@ -9,7 +9,7 @@ TYPEDEF_HIDES_STRUCT = YES EXTRACT_STATIC = YES SORT_MEMBER_DOCS = NO WARN_NO_PARAMDOC = YES -INPUT = ../../include ../../test +INPUT = ../../include ../../include/helper ./include ../../test FILE_PATTERNS = odp*.h odp*.c RECURSIVE = YES SOURCE_BROWSER = YES diff --git a/platform/linux-generic/include/odp_buffer_internal.h b/platform/linux-generic/include/odp_buffer_internal.h index c4e5b33..3930dc2 100644 --- a/platform/linux-generic/include/odp_buffer_internal.h +++ b/platform/linux-generic/include/odp_buffer_internal.h @@ -25,7 +25,7 @@ extern "C" { #include #include -/* TODO: move these to correct files */ +/** \todo move these to correct files */ typedef uint64_t odp_phys_addr_t;