From patchwork Tue Feb 3 16:48:18 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44264 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f72.google.com (mail-la0-f72.google.com [209.85.215.72]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 4E7452034D for ; Tue, 3 Feb 2015 16:49:29 +0000 (UTC) Received: by mail-la0-f72.google.com with SMTP id gq15sf21735714lab.3 for ; Tue, 03 Feb 2015 08:49:28 -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=a5C0vdkFW90FRqMNlYPVZfU7fHZn+dGcDyLv33kCBEc=; b=GuXtTiCd/8n5YmkxdOff+I8XctzcLnhZn1aSuQ8witAd9F5E0e3ShtdtafQSWj/1vX 8LZMGRpUXQRV7rCz7GChhGs3JE2HSWKLhRxQgieXiT5N/MP+ZHpL60jt72utAD8pYGqc xGpftffgzGbXg3rMf1fiOi8i9Ojf4fjJUWB1wKyRCMVkEQVmCUpDj9xefWYZwVTCiRLM o7wCUK//av6EntBR6kuyGwQizgsBa8jWJJcTNNdNSW6QjkCJNlSyV6oPXL3+8XR03DOv ZlcUS+1RJr9onLm5lItKg+S9ARubZuPhdyM/DZCM8ThFbvj7wz4LHGtY5KO0pQL/Utea A6vg== X-Gm-Message-State: ALoCoQk5d5d+7WJ+PGmbN4CWDMMkW5lS+V/gOuqLSz3xFJwM9nK4qqwU3yMdOltqQPi6ki7twxNh X-Received: by 10.112.180.167 with SMTP id dp7mr1482944lbc.14.1422982168287; Tue, 03 Feb 2015 08:49:28 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.42.141 with SMTP id o13ls702759lal.78.gmail; Tue, 03 Feb 2015 08:49:28 -0800 (PST) X-Received: by 10.112.129.195 with SMTP id ny3mr26145895lbb.10.1422982168145; Tue, 03 Feb 2015 08:49:28 -0800 (PST) Received: from mail-lb0-f174.google.com (mail-lb0-f174.google.com. [209.85.217.174]) by mx.google.com with ESMTPS id dh5si19708605lad.33.2015.02.03.08.49.28 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:49:28 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.174 as permitted sender) client-ip=209.85.217.174; Received: by mail-lb0-f174.google.com with SMTP id f15so39739395lbj.5 for ; Tue, 03 Feb 2015 08:49:28 -0800 (PST) X-Received: by 10.112.144.164 with SMTP id sn4mr20431208lbb.2.1422982168036; Tue, 03 Feb 2015 08:49:28 -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 h5csp2058536lbj; Tue, 3 Feb 2015 08:49:27 -0800 (PST) X-Received: by 10.224.79.144 with SMTP id p16mr54693733qak.84.1422982164548; Tue, 03 Feb 2015 08:49:24 -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 e34si29325664qge.99.2015.02.03.08.49.23 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:49:24 -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 1YIgfB-0008Dv-G8; Tue, 03 Feb 2015 16:49:21 +0000 Received: from mail-lb0-f172.google.com ([209.85.217.172]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIged-00086u-Fs for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 16:48:47 +0000 Received: by mail-lb0-f172.google.com with SMTP id l4so39791482lbv.3 for ; Tue, 03 Feb 2015 08:48:41 -0800 (PST) X-Received: by 10.112.32.34 with SMTP id f2mr10459019lbi.50.1422982121903; Tue, 03 Feb 2015 08:48:41 -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.40 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 08:48:41 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 17:48:18 +0100 Message-Id: <1422982108-13813-9-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 08/18] api: odp_init.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.174 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/init.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/include/odp/api/init.h b/include/odp/api/init.h index c73b321..c14769f 100644 --- a/include/odp/api/init.h +++ b/include/odp/api/init.h @@ -66,8 +66,8 @@ typedef enum odp_log_level { * @param[in] level Log level * @param[in] fmt printf-style message format * - * @return The number of characters logged if succeeded. Otherwise returns - * a negative number. + * @return The number of characters logged on success + * @retval <0 on failure */ int odp_override_log(odp_log_level_e level, const char *fmt, ...); @@ -108,8 +108,8 @@ typedef struct odp_platform_init_t { * @param[in] platform_params Those parameters that are passed without * interpretation by the ODP API to the implementation. * - * @retval 0 if successful - * @retval -1 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_init_global(odp_init_t *params, odp_platform_init_t *platform_params); @@ -133,8 +133,8 @@ int odp_init_global(odp_init_t *params, odp_platform_init_t *platform_params); * @sa odp_init_global() * @sa odp_term_local() which must have been called prior to this. * - * @retval 0 if successful - * @retval -1 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_term_global(void); @@ -147,8 +147,8 @@ int odp_term_global(void); * @sa odp_term_local() * @sa odp_init_global() which must have been called prior to this. * - * @retval 0 if successful - * @retval -1 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_init_local(void); @@ -170,8 +170,8 @@ int odp_init_local(void); * @warning The unwinding of HW resources to allow them to be re used without reseting * the device is a complex task that the application is expected to coordinate. * - * @retval 1 if successful and more ODP thread exists - * @retval 0 if successful and it was the last ODP thread + * @retval 1 on success and more ODP threads exist + * @retval 0 on success and no more ODP threads exist * @retval -1 on failure */ int odp_term_local(void);