From patchwork Tue Feb 3 16:48:22 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44267 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-we0-f198.google.com (mail-we0-f198.google.com [74.125.82.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 72D7A2034D for ; Tue, 3 Feb 2015 16:49:45 +0000 (UTC) Received: by mail-we0-f198.google.com with SMTP id q59sf21776669wes.1 for ; Tue, 03 Feb 2015 08:49:44 -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=LnWsFFHH+WMCiQC/WIHEOHvUE/ix/x3XQphjD08z5xFwf1BJc+WoNKQh5re0ajDMiZ i0dQiOuYg9WdgN1hcu8O9z9T97SsW4Asw2Z6rAMfqm/+wMzByFT9cnH1ZQdOpHXAy2dK YwHFFXyrRBmj/+oESKJTp5RlDh7MdNlNX9iI9M7YbHd98dtimSjEbp5MmbyO7k7Z1Iq6 rY4KFuX3ZkWKPU7usD4MQb7PHY6HqiRXo5bTtrTgXUvQiR6ZaDsgywXUKvr+oFdIF4V1 4+dU94mg+77hQBk1U+A1Xb4xkr1CmV2NBrnTdAOd1IYei3mPgQbNs3Uv0ja2HZNJ0afe GD1Q== X-Gm-Message-State: ALoCoQlChSv2sW0S9Ozv78IINuvfHKFFDrNmfajFt7f4bbb7cYvJlkW2/jIW18D5fO7EaeQDdjuU X-Received: by 10.194.161.194 with SMTP id xu2mr3266426wjb.1.1422982184775; Tue, 03 Feb 2015 08:49:44 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.170.168 with SMTP id an8ls778351lac.62.gmail; Tue, 03 Feb 2015 08:49:44 -0800 (PST) X-Received: by 10.152.23.195 with SMTP id o3mr4818459laf.70.1422982184538; Tue, 03 Feb 2015 08:49:44 -0800 (PST) Received: from mail-la0-f53.google.com (mail-la0-f53.google.com. [209.85.215.53]) by mx.google.com with ESMTPS id q5si19665430lbr.85.2015.02.03.08.49.44 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:49:44 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.53 as permitted sender) client-ip=209.85.215.53; Received: by mail-la0-f53.google.com with SMTP id gq15so53383237lab.12 for ; Tue, 03 Feb 2015 08:49:44 -0800 (PST) X-Received: by 10.112.125.41 with SMTP id mn9mr25515043lbb.80.1422982184436; Tue, 03 Feb 2015 08:49:44 -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 h5csp2058692lbj; Tue, 3 Feb 2015 08:49:43 -0800 (PST) X-Received: by 10.224.46.8 with SMTP id h8mr55233463qaf.0.1422982182870; Tue, 03 Feb 2015 08:49:42 -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 p1si29442694qaa.13.2015.02.03.08.49.40 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:49:42 -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 1YIgfS-0008Gw-Sl; Tue, 03 Feb 2015 16:49:38 +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 1YIgeh-00087J-Tg for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 16:48:52 +0000 Received: by mail-la0-f54.google.com with SMTP id hv19so53197142lab.13 for ; Tue, 03 Feb 2015 08:48:46 -0800 (PST) X-Received: by 10.152.206.2 with SMTP id lk2mr21339963lac.13.1422982126384; Tue, 03 Feb 2015 08:48:46 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id y2sm434179lay.23.2015.02.03.08.48.45 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 08:48:45 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 17:48:22 +0100 Message-Id: <1422982108-13813-13-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422982108-13813-1-git-send-email-ola.liljedahl@linaro.org> References: <1422982108-13813-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv5 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.53 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);