From patchwork Wed Sep 3 02:18:11 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 36538 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-pa0-f70.google.com (mail-pa0-f70.google.com [209.85.220.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id B054E20C87 for ; Wed, 3 Sep 2014 02:18:45 +0000 (UTC) Received: by mail-pa0-f70.google.com with SMTP id lf10sf78992099pab.9 for ; Tue, 02 Sep 2014 19:18:44 -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=CnH4jNX0nl97sM7Ds0wd3LzLi9kTRNGStxYp8bhoHQY=; b=IHXl2YjOOgZUmc3qRlE4Yg3Tg1CfHWqHNnRGKBKdWwtGtcAuVmoCJR5eY1w3Iaai4I yobneO2vrcKDst8p/TzoB40pt96i47T2zfxTWLiSj4wBXXhnGEJjwx6CUJaZ9iKq98ag i0yha3twdWX5a3Nyl1YnpFv4OLXuF85F+6cO3JyQf7wC7IbjfxF99P9m8sXW5WWjjKjp vYCY47Cmb11snZpvIo8htqVIAdXtq7IUIZYRSmY/oONhJzRqrL7XKycHDscbCmGxrpcd +7/bV0ClPNqhS/U7CeZp1SSQvXnYpALdDoHZKrVzx2mhcwAGY9U3BtU3QlH3FJuRdgWk ch7w== X-Gm-Message-State: ALoCoQm5j6U9qnmJ9ZxaRVDPp7WFXMGuBdZOIdSMkCa/Jsw08+Ypn6ql/1cnb5fwdXQvJhptxIyg X-Received: by 10.66.220.37 with SMTP id pt5mr21459820pac.24.1409710724963; Tue, 02 Sep 2014 19:18:44 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.83.230 with SMTP id j93ls2672324qgd.40.gmail; Tue, 02 Sep 2014 19:18:44 -0700 (PDT) X-Received: by 10.220.175.17 with SMTP id v17mr3300387vcz.0.1409710724833; Tue, 02 Sep 2014 19:18:44 -0700 (PDT) Received: from mail-vc0-f175.google.com (mail-vc0-f175.google.com [209.85.220.175]) by mx.google.com with ESMTPS id 16si374709vdf.0.2014.09.02.19.18.44 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 02 Sep 2014 19:18:44 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.175 as permitted sender) client-ip=209.85.220.175; Received: by mail-vc0-f175.google.com with SMTP id lf12so8074239vcb.34 for ; Tue, 02 Sep 2014 19:18:44 -0700 (PDT) X-Received: by 10.52.164.199 with SMTP id ys7mr2982435vdb.42.1409710724754; Tue, 02 Sep 2014 19:18:44 -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.221.45.67 with SMTP id uj3csp613611vcb; Tue, 2 Sep 2014 19:18:44 -0700 (PDT) X-Received: by 10.224.28.133 with SMTP id m5mr61525082qac.16.1409710724294; Tue, 02 Sep 2014 19:18:44 -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 g92si7604737qge.32.2014.09.02.19.18.43 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 02 Sep 2014 19:18:44 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) 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 1XP09i-0005em-6F; Wed, 03 Sep 2014 02:18:42 +0000 Received: from mail-qg0-f53.google.com ([209.85.192.53]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XP09c-0005eh-Hy for lng-odp@lists.linaro.org; Wed, 03 Sep 2014 02:18:36 +0000 Received: by mail-qg0-f53.google.com with SMTP id z107so7492053qgd.40 for ; Tue, 02 Sep 2014 19:18:31 -0700 (PDT) X-Received: by 10.140.30.74 with SMTP id c68mr33341026qgc.63.1409710711318; Tue, 02 Sep 2014 19:18:31 -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 a17sm7279206qgf.12.2014.09.02.19.18.30 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 02 Sep 2014 19:18:30 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 2 Sep 2014 22:18:11 -0400 Message-Id: <1409710691-22816-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCH] doxygen: Add a buffer module 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: 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.220.175 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 Signed-off-by: Mike Holmes --- This creates a new section in the documentaion to group everything related to buffers. It appears to make things much more acessable although it needs to have some real description added to the section. platform/linux-generic/include/api/odp_buffer.h | 6 +++++- platform/linux-generic/include/api/odp_buffer_pool.h | 6 ++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/platform/linux-generic/include/api/odp_buffer.h b/platform/linux-generic/include/api/odp_buffer.h index d8577fd..4f348e4 100644 --- a/platform/linux-generic/include/api/odp_buffer.h +++ b/platform/linux-generic/include/api/odp_buffer.h @@ -21,7 +21,10 @@ extern "C" { #include - +/** + * @addtogroup buffer + * @{ + */ /** * ODP buffer @@ -83,6 +86,7 @@ int odp_buffer_is_valid(odp_buffer_t buf); */ void odp_buffer_print(odp_buffer_t buf); +/** @} */ #ifdef __cplusplus } diff --git a/platform/linux-generic/include/api/odp_buffer_pool.h b/platform/linux-generic/include/api/odp_buffer_pool.h index fe88898..dd0ac43 100644 --- a/platform/linux-generic/include/api/odp_buffer_pool.h +++ b/platform/linux-generic/include/api/odp_buffer_pool.h @@ -23,6 +23,11 @@ extern "C" { #include #include +/** + * @addtogroup buffer ODP Buffers and buffer Pools + * @{ + */ + /** Maximum queue name lenght in chars */ #define ODP_BUFFER_POOL_NAME_LEN 32 @@ -99,6 +104,7 @@ void odp_buffer_free(odp_buffer_t buf); */ odp_buffer_pool_t odp_buffer_pool(odp_buffer_t buf); +/** @} */ #ifdef __cplusplus }