From patchwork Mon Dec 15 17:09:52 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Taras Kondratiuk X-Patchwork-Id: 42270 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f70.google.com (mail-wg0-f70.google.com [74.125.82.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 221E126C6C for ; Mon, 15 Dec 2014 17:11:10 +0000 (UTC) Received: by mail-wg0-f70.google.com with SMTP id b13sf7536045wgh.1 for ; Mon, 15 Dec 2014 09:11:09 -0800 (PST) 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:in-reply-to :references: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=VjVCZeNQLytNZq/AMp4LN2B+P9pPEeO1TZOyx7IvmMw=; b=TqWPSSFXCGl6cuIrA+G5BuZj40NLOr8vAxVLSx+No48XTDZFUyi/5x0S+iYHkrQy+V TKKNJsFSdYolvpvqO2s+X5P5ja85cIJtNZGVSM+oswRyR5Xtrn9vJ6v8GK545hbrtNQS Aiff2+Y2X26wJTG6L7XahzBxT8d939/fXHWa5roF25zO9LoUoKFIJCV9SP73k3IiQwnA 2dsSL9i4k47YO/fO/QD4f4UYUo+vzvrDu4iTkOMV2QWt3ZZ5gE7UswgL4f5DfYr/Mgj0 vORw7Zj2tzopBZ5zEAwCbY0vCxPhtkL/oH6uQw32RKbuAkHh1EJ8OoicxWHWrn1SW72S 4NSw== X-Gm-Message-State: ALoCoQkWdUjw4FRxgLpBid9u0kZ5bIBkrSgL5GOeYXAtyUBDNZJKWuYZTRfNsNHn+WXsbxTOBlfb X-Received: by 10.112.42.104 with SMTP id n8mr217260lbl.19.1418663469322; Mon, 15 Dec 2014 09:11:09 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.3.170 with SMTP id d10ls674016lad.37.gmail; Mon, 15 Dec 2014 09:11:09 -0800 (PST) X-Received: by 10.152.29.129 with SMTP id k1mr10466479lah.10.1418663469088; Mon, 15 Dec 2014 09:11:09 -0800 (PST) Received: from mail-la0-f52.google.com (mail-la0-f52.google.com. [209.85.215.52]) by mx.google.com with ESMTPS id is2si11085132lac.12.2014.12.15.09.11.09 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 15 Dec 2014 09:11:09 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.52 as permitted sender) client-ip=209.85.215.52; Received: by mail-la0-f52.google.com with SMTP id hs14so9667683lab.39 for ; Mon, 15 Dec 2014 09:11:09 -0800 (PST) X-Received: by 10.112.130.132 with SMTP id oe4mr31056327lbb.82.1418663469008; Mon, 15 Dec 2014 09:11:09 -0800 (PST) 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.142.69 with SMTP id ru5csp782178lbb; Mon, 15 Dec 2014 09:11:08 -0800 (PST) X-Received: by 10.224.122.15 with SMTP id j15mr58492060qar.68.1418663467310; Mon, 15 Dec 2014 09:11:07 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id k1si7800326qce.32.2014.12.15.09.11.06 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 15 Dec 2014 09:11:07 -0800 (PST) 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-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Y0ZAm-0000xd-Nc; Mon, 15 Dec 2014 17:11:04 +0000 Received: from mail-la0-f54.google.com ([209.85.215.54]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Y0ZA1-0000dP-Qh for lng-odp@lists.linaro.org; Mon, 15 Dec 2014 17:10:17 +0000 Received: by mail-la0-f54.google.com with SMTP id pv20so9833033lab.13 for ; Mon, 15 Dec 2014 09:10:12 -0800 (PST) X-Received: by 10.112.234.201 with SMTP id ug9mr31103645lbc.79.1418663412278; Mon, 15 Dec 2014 09:10:12 -0800 (PST) Received: from localhost.localdomain ([80.77.38.170]) by mx.google.com with ESMTPSA id l9sm1208585lae.0.2014.12.15.09.10.10 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 15 Dec 2014 09:10:11 -0800 (PST) From: Taras Kondratiuk To: lng-odp@lists.linaro.org Date: Mon, 15 Dec 2014 19:09:52 +0200 Message-Id: <1418663392-28354-8-git-send-email-taras.kondratiuk@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1418663392-28354-1-git-send-email-taras.kondratiuk@linaro.org> References: <1418663392-28354-1-git-send-email-taras.kondratiuk@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv6 7/7] api: buffer: update documentation comments 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: taras.kondratiuk@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.52 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 From: Bill Fischofer Signed-off-by: Bill Fischofer Signed-off-by: Taras Kondratiuk --- platform/linux-generic/include/api/odp_buffer.h | 4 ++-- platform/linux-generic/include/api/odp_buffer_pool.h | 13 +++++++++---- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/platform/linux-generic/include/api/odp_buffer.h b/platform/linux-generic/include/api/odp_buffer.h index a7036e8..3c23035 100644 --- a/platform/linux-generic/include/api/odp_buffer.h +++ b/platform/linux-generic/include/api/odp_buffer.h @@ -62,13 +62,13 @@ int odp_buffer_type(odp_buffer_t buf); #define ODP_BUFFER_TYPE_PACKET 2 /**< Packet buffer */ #define ODP_BUFFER_TYPE_TIMEOUT 3 /**< Timeout buffer */ - /** * Tests if buffer is valid * * @param buf Buffer handle * - * @return 1 if valid, otherwise 0 + * @retval 1 Buffer handle represents a valid buffer. + * @retval 0 Buffer handle does not represent a valid buffer. */ int odp_buffer_is_valid(odp_buffer_t buf); diff --git a/platform/linux-generic/include/api/odp_buffer_pool.h b/platform/linux-generic/include/api/odp_buffer_pool.h index e6bf5a7..4da5f84 100644 --- a/platform/linux-generic/include/api/odp_buffer_pool.h +++ b/platform/linux-generic/include/api/odp_buffer_pool.h @@ -100,7 +100,11 @@ int odp_buffer_pool_destroy(odp_buffer_pool_t pool); * * @param name Name of the pool * - * @return Buffer pool handle, or ODP_BUFFER_POOL_INVALID if not found. + * @return Handle of found buffer pool + * @retval ODP_BUFFER_POOL_INVALID Buffer pool could not be found + * + * @note This routine cannot be used to look up an anonymous pool (one created + * with no name). */ odp_buffer_pool_t odp_buffer_pool_lookup(const char *name); @@ -138,21 +142,22 @@ int odp_buffer_pool_info(odp_buffer_pool_t pool, * * @param pool Pool handle * + * @note This routine writes implementation-defined information about the + * specified buffer pool to the ODP log. The intended use is for debugging. */ void odp_buffer_pool_print(odp_buffer_pool_t pool); - /** * Buffer alloc * * The validity of a buffer can be cheked at any time with odp_buffer_is_valid() * @param pool Pool handle * - * @return Buffer handle or ODP_BUFFER_INVALID + * @return Handle of allocated buffer + * @retval ODP_BUFFER_INVALID Buffer could not be allocated */ odp_buffer_t odp_buffer_alloc(odp_buffer_pool_t pool); - /** * Buffer free *