From patchwork Tue Feb 3 14:53:11 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44236 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 A69432034D for ; Tue, 3 Feb 2015 14:54:36 +0000 (UTC) Received: by mail-we0-f197.google.com with SMTP id l61sf21225278wev.0 for ; Tue, 03 Feb 2015 06:54:35 -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=IZ7ADkVREspP8bkjj2dKTHTzyWWy4iHXi0u0oCral+3X6U243LWaMDNw4sTuRPxgIU Ih3HPVsj3f6AwtJt4d2N9ypIaKwC47ZdotrlusgBNgZhQQyGT6uMigoW4p4oIDZ+4wA9 SIltkapL4xyS1HmIsV4IQWBUM6VfRQ5/1JXW5Fx2gKOTxs9d1afviP9mqW7RPMn4dGKr OgzAV0RFonKwKMVC8vYamXf8YC/C0E/yadAsK5rBNaaZMd/7NzLaSxwDF2iw7TZf/W+O l9kCapB4i3lSIxGODWeh4rB+8snATCFUiFZhhuKb2NFlzpiNFB/wbkNFQqbkWv0QDu+G yYFw== X-Gm-Message-State: ALoCoQmI1zfbyedp9AMtnWkg+6bVLdkrvbxVw1FAV+YYaakZIktVqmOlB0pBgNbsB8H5RnE0NTJ6 X-Received: by 10.112.133.98 with SMTP id pb2mr3222291lbb.2.1422975275900; Tue, 03 Feb 2015 06:54:35 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.37.194 with SMTP id a2ls249084lak.108.gmail; Tue, 03 Feb 2015 06:54:35 -0800 (PST) X-Received: by 10.152.43.193 with SMTP id y1mr21394582lal.35.1422975275719; Tue, 03 Feb 2015 06:54:35 -0800 (PST) Received: from mail-la0-f50.google.com (mail-la0-f50.google.com. [209.85.215.50]) by mx.google.com with ESMTPS id ry10si16697052lbb.117.2015.02.03.06.54.35 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 06:54:35 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.50 as permitted sender) client-ip=209.85.215.50; Received: by mail-la0-f50.google.com with SMTP id hs14so52387294lab.9 for ; Tue, 03 Feb 2015 06:54:35 -0800 (PST) X-Received: by 10.152.36.162 with SMTP id r2mr11791713laj.9.1422975275607; Tue, 03 Feb 2015 06:54:35 -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 h5csp1988074lbj; Tue, 3 Feb 2015 06:54:34 -0800 (PST) X-Received: by 10.224.5.131 with SMTP id 3mr54444333qav.36.1422975274031; Tue, 03 Feb 2015 06:54:34 -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 b102si389778qge.107.2015.02.03.06.54.32 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 06:54:34 -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 1YIes2-0001fi-R2; Tue, 03 Feb 2015 14:54:30 +0000 Received: from mail-la0-f43.google.com ([209.85.215.43]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIerF-0001Y6-1d for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 14:53:41 +0000 Received: by mail-la0-f43.google.com with SMTP id pn19so6444117lab.2 for ; Tue, 03 Feb 2015 06:53:35 -0800 (PST) X-Received: by 10.112.40.65 with SMTP id v1mr25154628lbk.26.1422975215471; Tue, 03 Feb 2015 06:53:35 -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.34 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 06:53:34 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 15:53:11 +0100 Message-Id: <1422975201-3364-9-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 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.215.50 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);