From patchwork Tue Feb 3 14:53:16 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44241 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f72.google.com (mail-wg0-f72.google.com [74.125.82.72]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 20B482034D for ; Tue, 3 Feb 2015 14:55:08 +0000 (UTC) Received: by mail-wg0-f72.google.com with SMTP id k14sf21081144wgh.3 for ; Tue, 03 Feb 2015 06:55:07 -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=msh2+smvlbxHBYQyF2dov7XS8L7GmgwaKO9+WsegfUw=; b=Sp4JRYCJ7HK7gzsmondMZ56Lnu55nynEfgx9NzrboYWLzgprKg37ZuYwkWk6GBEE/o EkumBr6mu8CggA/T4VvPIedqYfDuHuIEiPRzVputsly3aFSlnhv4Va0r2lSXpz+QvnRD 1hvMAfthXnK9BpZZMZSbhVwfCBJmPE9YMUc4EvVvwhAohgpErdjgF6jcK4Rov61N9UlO VFdBS/Nts17xznY0JSaHrtFIr/hyZ2klepdK7BS5JLHREDFg4jYAXYmV+mZY57i8BqRu nrXatvGT6dYxBOyP9TgS1FhRVSHOKeB1hUs7Y/fV2fBu0No1cfsQS4ZQLV94wMrFgMlA XEKQ== X-Gm-Message-State: ALoCoQkl8vZvJnRr89/WcK3+dEIR+hUC8xDtavMg6GdkiHXzMwfnbBiTKZew8qpSy45NqvUS7Ccq X-Received: by 10.112.181.198 with SMTP id dy6mr3248844lbc.22.1422975307346; Tue, 03 Feb 2015 06:55:07 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.37.194 with SMTP id a2ls249142lak.108.gmail; Tue, 03 Feb 2015 06:55:07 -0800 (PST) X-Received: by 10.112.67.41 with SMTP id k9mr25060396lbt.35.1422975307210; Tue, 03 Feb 2015 06:55:07 -0800 (PST) Received: from mail-la0-f51.google.com (mail-la0-f51.google.com. [209.85.215.51]) by mx.google.com with ESMTPS id b1si19346091lab.72.2015.02.03.06.55.07 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 06:55:07 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.51 as permitted sender) client-ip=209.85.215.51; Received: by mail-la0-f51.google.com with SMTP id ge10so52623285lab.10 for ; Tue, 03 Feb 2015 06:55:07 -0800 (PST) X-Received: by 10.152.203.230 with SMTP id kt6mr24150906lac.38.1422975307098; Tue, 03 Feb 2015 06:55:07 -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 h5csp1988345lbj; Tue, 3 Feb 2015 06:55:06 -0800 (PST) X-Received: by 10.140.29.138 with SMTP id b10mr21780421qgb.78.1422975305637; Tue, 03 Feb 2015 06:55:05 -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 d7si13227978qac.80.2015.02.03.06.55.04 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 06:55:05 -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 1YIesY-0001lr-I0; Tue, 03 Feb 2015 14:55:02 +0000 Received: from mail-la0-f41.google.com ([209.85.215.41]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIerK-0001Yi-0O for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 14:53:46 +0000 Received: by mail-la0-f41.google.com with SMTP id gm9so52585797lab.0 for ; Tue, 03 Feb 2015 06:53:40 -0800 (PST) X-Received: by 10.112.170.100 with SMTP id al4mr4197921lbc.42.1422975220439; Tue, 03 Feb 2015 06:53:40 -0800 (PST) Received: from localhost.localdomain (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id jf3sm5082572lbc.44.2015.02.03.06.53.39 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 06:53:39 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 15:53:16 +0100 Message-Id: <1422975201-3364-14-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422975201-3364-1-git-send-email-ola.liljedahl@linaro.org> References: <1422975201-3364-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCHv4 13/18] api: odp_schedule.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.51 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/schedule.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/odp/api/schedule.h b/include/odp/api/schedule.h index 71264a7..3019b84 100644 --- a/include/odp/api/schedule.h +++ b/include/odp/api/schedule.h @@ -65,7 +65,8 @@ uint64_t odp_schedule_wait_time(uint64_t ns); * Use odp_schedule_wait_time() to convert time to other wait * values. * - * @return Next highest priority event, or ODP_EVENT_INVALID + * @return Next highest priority event + * @retval ODP_EVENT_INVALID on timeout and no events available */ odp_event_t odp_schedule(odp_queue_t *from, uint64_t wait);