From patchwork Mon Feb 2 17:20:40 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44165 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f69.google.com (mail-la0-f69.google.com [209.85.215.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 14EAC202A5 for ; Mon, 2 Feb 2015 17:21:22 +0000 (UTC) Received: by mail-la0-f69.google.com with SMTP id gm9sf17183887lab.0 for ; Mon, 02 Feb 2015 09:21:21 -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=ePtqu0aKHMY75MupqU2eCJe/01Z0UubQvaw7CQHnNM0=; b=TyjD6aaGwR4iCYh2+agpTpreSP6Bc2wHREegywSSRdTAS/IbI/+YDWg/HiiKiTM2C0 RJ88/bWAaoLLPhcQhattNHjBGAkDAu2Mih6oXZigESgJXQ6g919QbJAgg/DVx03hCIlx oUW6YBk7xfsUlSlYxHcNu4JcaSB9iGPtvbSLE11kFMUCZ0NcFSco5kmzxExuRw5d/MWu rZ9BunjdIce8zXXDdHkoLqI1ItQ3CCsG3k5me/BXVqiNb8ao3HG1GgnKbkzNUOmXNEe7 TDBaL30LaTUpLKi8RLjZ/yl4gL5IORGry5htE1dA09psUJOCLVV0/Kag09/ZMoH3ATf+ QdHg== X-Gm-Message-State: ALoCoQmaK5KYn9ecdYbplpHxXJqlT79yDNTP2DAY/ZBeSq0qC37/Lszm8xJ+K1EFOtG5xwk453dv X-Received: by 10.152.26.74 with SMTP id j10mr2539534lag.10.1422897681104; Mon, 02 Feb 2015 09:21:21 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.28.132 with SMTP id b4ls121246lah.16.gmail; Mon, 02 Feb 2015 09:21:20 -0800 (PST) X-Received: by 10.152.43.193 with SMTP id y1mr17168882lal.35.1422897680949; Mon, 02 Feb 2015 09:21:20 -0800 (PST) Received: from mail-la0-f54.google.com (mail-la0-f54.google.com. [209.85.215.54]) by mx.google.com with ESMTPS id w1si9748165lag.6.2015.02.02.09.21.20 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 02 Feb 2015 09:21:20 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.54 as permitted sender) client-ip=209.85.215.54; Received: by mail-la0-f54.google.com with SMTP id hv19so43012631lab.13 for ; Mon, 02 Feb 2015 09:21:20 -0800 (PST) X-Received: by 10.152.8.1 with SMTP id n1mr19957060laa.47.1422897680442; Mon, 02 Feb 2015 09:21:20 -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.35.133 with SMTP id h5csp1431047lbj; Mon, 2 Feb 2015 09:21:19 -0800 (PST) X-Received: by 10.224.61.2 with SMTP id r2mr42831956qah.92.1422897679150; Mon, 02 Feb 2015 09:21:19 -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 ef9si15708653qcb.15.2015.02.02.09.21.17 (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 02 Feb 2015 09:21:19 -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 1YIKgW-00070B-5U; Mon, 02 Feb 2015 17:21:16 +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 1YIKgF-0006yu-Pw for lng-odp@lists.linaro.org; Mon, 02 Feb 2015 17:20:59 +0000 Received: by mail-la0-f54.google.com with SMTP id hv19so43007967lab.13 for ; Mon, 02 Feb 2015 09:20:54 -0800 (PST) X-Received: by 10.112.136.233 with SMTP id qd9mr3308415lbb.61.1422897654164; Mon, 02 Feb 2015 09:20:54 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id rv1sm4530726lbb.25.2015.02.02.09.20.53 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 02 Feb 2015 09:20:53 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Mon, 2 Feb 2015 18:20:40 +0100 Message-Id: <1422897646-8064-3-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422897646-8064-1-git-send-email-ola.liljedahl@linaro.org> References: <1422897646-8064-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv3 12/18] api: odp_queue.h: updated return descriptions 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: ola.liljedahl@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.54 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 Updated doxygen descriptions, particularly the @return/@retval descriptions. No change of implementation necessary. Signed-off-by: Ola Liljedahl --- (This document/code contribution attached is provided under the terms of agreement LES-LTM-21309) include/odp/api/queue.h | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h index 377a7da..b06522c 100644 --- a/include/odp/api/queue.h +++ b/include/odp/api/queue.h @@ -158,7 +158,8 @@ typedef struct odp_queue_param_t { * @param type Queue type * @param param Queue parameters. Uses defaults if NULL. * - * @return Queue handle or ODP_QUEUE_INVALID + * @return Queue handle + * @retval ODP_QUEUE_INVALID on failure */ odp_queue_t odp_queue_create(const char *name, odp_queue_type_t type, odp_queue_param_t *param); @@ -173,7 +174,8 @@ odp_queue_t odp_queue_create(const char *name, odp_queue_type_t type, * * @param queue Queue handle * - * @return 0 if successful + * @retval 0 on success + * @retval <0 on failure */ int odp_queue_destroy(odp_queue_t queue); @@ -182,7 +184,8 @@ int odp_queue_destroy(odp_queue_t queue); * * @param name Queue name * - * @return Queue handle or ODP_QUEUE_INVALID + * @return Queue handle + * @retval ODP_QUEUE_INVALID on failure */ odp_queue_t odp_queue_lookup(const char *name); @@ -196,7 +199,8 @@ odp_queue_t odp_queue_lookup(const char *name); * @param queue Queue handle * @param context Address to the queue context * - * @return 0 if successful + * @retval 0 on success + * @retval <0 on failure */ int odp_queue_set_context(odp_queue_t queue, void *context); @@ -205,8 +209,8 @@ int odp_queue_set_context(odp_queue_t queue, void *context); * * @param queue Queue handle * - * @return If successful, a pointer to the queue context, - * NULL for failure. + * @return pointer to the queue context + * @retval NULL on failure */ void *odp_queue_get_context(odp_queue_t queue); @@ -216,7 +220,8 @@ void *odp_queue_get_context(odp_queue_t queue); * @param queue Queue handle * @param ev Event handle * - * @return 0 if succesful + * @retval 0 on success + * @retval <0 on failure (e.g. queue full) */ int odp_queue_enq(odp_queue_t queue, odp_event_t ev); @@ -240,7 +245,8 @@ int odp_queue_enq_multi(odp_queue_t queue, const odp_event_t events[], int num); * * @param queue Queue handle * - * @return Event handle, or ODP_EVENT_INVALID + * @return Event handle + * @retval ODP_EVENT_INVALID on failure (e.g. queue empty) */ odp_event_t odp_queue_deq(odp_queue_t queue); @@ -251,10 +257,11 @@ odp_event_t odp_queue_deq(odp_queue_t queue); * ODP_QUEUE_TYPE_SCHED type queues (use odp_schedule() instead). * * @param queue Queue handle - * @param events Event handle array for output - * @param num Maximum number of event handles + * @param[out] events Array of event handles for output + * @param num Maximum number of events to dequeue - * @return Number of events written (0 ... num) + * @return Number of events actually dequeued (0 ... num) + * @retval <0 on failure */ int odp_queue_deq_multi(odp_queue_t queue, odp_event_t events[], int num);