From patchwork Tue Feb 3 16:48:23 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44269 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-we0-f197.google.com (mail-we0-f197.google.com [74.125.82.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 8E69C2034D for ; Tue, 3 Feb 2015 16:49:53 +0000 (UTC) Received: by mail-we0-f197.google.com with SMTP id l61sf21723803wev.0 for ; Tue, 03 Feb 2015 08:49:52 -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=JGj6k4Jxkk6Lgxr2mdTZ3s5+rB19H1P5BkBcSkhF8rBcHSgQoEqI/+oG+posEccIpF QZvziKJ2uFDGIHaKmQmyTFgGoOrvfQgPkLoB/j7QyGAblGAIHyQCkh4fSbsYNWzE/8te aL2u6Ey+uf2GTEPOUf3/13tpAK4g9xwXndFNc94+RW1N0ER8pegGjAruwqJMpi39B1ct SgcdZ0UklfM7YV7KMEOs2yAeOjxsJqzHWOnIYiobcfFSYVWs+jBEeHStY/yp/CC8wcQJ kgno5U1epnHQxZGieUaC3vwvsbxnc2rhn9cljq11X2BH//hUPCUgAY//Zpdxf1uE3uzw NcXA== X-Gm-Message-State: ALoCoQmAJ4UWO9VC6a2A9h+gU1Tj9Y7P9l9i6dqq1iji+1o7HLC85Bt70jtpi+ryJ1QIZXzPfkeh X-Received: by 10.180.84.7 with SMTP id u7mr2096722wiy.0.1422982192845; Tue, 03 Feb 2015 08:49:52 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.203.134 with SMTP id kq6ls721901lac.36.gmail; Tue, 03 Feb 2015 08:49:52 -0800 (PST) X-Received: by 10.152.43.97 with SMTP id v1mr4176109lal.85.1422982192693; Tue, 03 Feb 2015 08:49:52 -0800 (PST) Received: from mail-lb0-f171.google.com (mail-lb0-f171.google.com. [209.85.217.171]) by mx.google.com with ESMTPS id t1si19661476lag.91.2015.02.03.08.49.52 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:49:52 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.171 as permitted sender) client-ip=209.85.217.171; Received: by mail-lb0-f171.google.com with SMTP id u14so39582805lbd.2 for ; Tue, 03 Feb 2015 08:49:52 -0800 (PST) X-Received: by 10.152.228.161 with SMTP id sj1mr4872640lac.74.1422982192429; Tue, 03 Feb 2015 08:49:52 -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 h5csp2058764lbj; Tue, 3 Feb 2015 08:49:51 -0800 (PST) X-Received: by 10.140.30.7 with SMTP id c7mr18465468qgc.48.1422982190051; Tue, 03 Feb 2015 08:49:50 -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 c91si29335486qgc.92.2015.02.03.08.49.44 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:49:50 -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 1YIgfW-0008Hh-8J; Tue, 03 Feb 2015 16:49:42 +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 1YIgei-00087P-Qk for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 16:48:52 +0000 Received: by mail-la0-f41.google.com with SMTP id gm9so53477597lab.0 for ; Tue, 03 Feb 2015 08:48:47 -0800 (PST) X-Received: by 10.152.23.195 with SMTP id o3mr4811616laf.70.1422982127252; Tue, 03 Feb 2015 08:48:47 -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.46 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 08:48:46 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 17:48:23 +0100 Message-Id: <1422982108-13813-14-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 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.217.171 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);