From patchwork Thu Jan 29 10:40:04 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 43913 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f198.google.com (mail-lb0-f198.google.com [209.85.217.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 5413C24119 for ; Thu, 29 Jan 2015 10:41:42 +0000 (UTC) Received: by mail-lb0-f198.google.com with SMTP id l4sf18098956lbv.1 for ; Thu, 29 Jan 2015 02:41:41 -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=an1h9LWxeZmz8eAfx+ocAXV3w8K1ipGHlfiS1xXULOw=; b=F+DSJThVs46ya5YgY+aoPEUr8L8QLkInLKFwDhPUzXnGYC6Hkeakcd6Hjb7tqtHry4 zju4i+MJ27CjQ8TCB6ibEzPyjmFrAEfgNbeVFpmw/y8/jrOMtU70upCPCedGgbyAfevp 29+rQyvy+53QfaNYFPTEQWsPL1Ar8KJKAY2Z3PlDoKhxdCWEbxTgOZbVqsa3vTik660E hJjn9X6aZxyN34UDchma5rSFjNMLtOHSfXnnoAy2l9DHRX2jfLlCUfaiFyIPdnwYT2JN 3fKD0OihaoOyM1st8bzAM1aoWI04cSfBEro8vwWdvSODmbH3Z0bufiHXi0vw9dmA5mq+ qvWw== X-Gm-Message-State: ALoCoQmNww/rUiSeUDupJXmOGVkVd1F91C9KRhlpDcIOXZHLrV7lpDNm4/SfhaHB2Ags8DxwjRV4 X-Received: by 10.112.181.198 with SMTP id dy6mr1699552lbc.22.1422528101341; Thu, 29 Jan 2015 02:41:41 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.206.37 with SMTP id ll5ls303620lac.53.gmail; Thu, 29 Jan 2015 02:41:41 -0800 (PST) X-Received: by 10.112.140.196 with SMTP id ri4mr13308299lbb.55.1422528101199; Thu, 29 Jan 2015 02:41:41 -0800 (PST) Received: from mail-lb0-f175.google.com (mail-lb0-f175.google.com. [209.85.217.175]) by mx.google.com with ESMTPS id t10si6982030lat.87.2015.01.29.02.41.41 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:41:41 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.175 as permitted sender) client-ip=209.85.217.175; Received: by mail-lb0-f175.google.com with SMTP id 10so26571521lbg.6 for ; Thu, 29 Jan 2015 02:41:41 -0800 (PST) X-Received: by 10.152.5.226 with SMTP id v2mr13496696lav.34.1422528101109; Thu, 29 Jan 2015 02:41:41 -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 h5csp1719639lbj; Thu, 29 Jan 2015 02:41:40 -0800 (PST) X-Received: by 10.140.109.164 with SMTP id l33mr2709qgf.91.1422528099846; Thu, 29 Jan 2015 02:41:39 -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 76si9768802qgk.40.2015.01.29.02.41.38 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:41:39 -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 1YGmXZ-0007Rx-1w; Thu, 29 Jan 2015 10:41:37 +0000 Received: from mail-lb0-f171.google.com ([209.85.217.171]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YGmWS-0007JG-Im for lng-odp@lists.linaro.org; Thu, 29 Jan 2015 10:40:28 +0000 Received: by mail-lb0-f171.google.com with SMTP id u14so26467413lbd.2 for ; Thu, 29 Jan 2015 02:40:23 -0800 (PST) X-Received: by 10.112.8.41 with SMTP id o9mr85519lba.40.1422528023068; Thu, 29 Jan 2015 02:40:23 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id y11sm2037670lba.5.2015.01.29.02.40.22 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 29 Jan 2015 02:40:22 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Thu, 29 Jan 2015 11:40:04 +0100 Message-Id: <1422528008-29845-13-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422528008-29845-1-git-send-email-ola.liljedahl@linaro.org> References: <1422528008-29845-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 12/16] 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.175 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) platform/linux-generic/include/api/odp_schedule.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/platform/linux-generic/include/api/odp_schedule.h b/platform/linux-generic/include/api/odp_schedule.h index 688a6db..edf26a2 100644 --- a/platform/linux-generic/include/api/odp_schedule.h +++ b/platform/linux-generic/include/api/odp_schedule.h @@ -59,7 +59,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);