From patchwork Thu Jan 29 10:39:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 43909 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id E620B24119 for ; Thu, 29 Jan 2015 10:41:03 +0000 (UTC) Received: by mail-lb0-f197.google.com with SMTP id b6sf18148380lbj.0 for ; Thu, 29 Jan 2015 02:41:02 -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=6tI5XzQ1YjdrgmWtkhpqQ67zidYSLUnC0WykNVLYF50=; b=Im1YyzmtHhGWvyvYf9ucp91E2rz4pkBlv+TetXcxX4cqgabIgYJvmSbeAAXK29VoC4 PT0+j2nrYqDayM0hCvV7TU2t+fd1bLtjgGvmnfI75thDDt5G2BGQUgHkEkR27W7nHguW ocrySu+28EPsdPeSdrIH+DXKL1ri1iuLQAw4p5gK0GhKzYTKEKKCkIvAdUdAUPhJGs/L FO4ODw85wA/MkMvH0+ourMkkXg7r1cumvgFmYK5fap5xTfC5HLaJDUOX3OkDiE9P7weK Z881vlSsMnsdIYfrPbanmOT9/4LyJfGRbPw67TZWFImScDlJZ384qum5ZgQDYM3+wCXb p6UQ== X-Gm-Message-State: ALoCoQlcEXEUYvUHJ7L+e3jFpktVKLXu9/72YRNCMS+CrAoiW8Skw93y0koBnEkXq/h5HjybmZ7E X-Received: by 10.112.161.201 with SMTP id xu9mr1670222lbb.11.1422528062974; Thu, 29 Jan 2015 02:41:02 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.27.137 with SMTP id t9ls266560lag.44.gmail; Thu, 29 Jan 2015 02:41:02 -0800 (PST) X-Received: by 10.152.20.169 with SMTP id o9mr13615809lae.50.1422528062829; Thu, 29 Jan 2015 02:41:02 -0800 (PST) Received: from mail-lb0-f177.google.com (mail-lb0-f177.google.com. [209.85.217.177]) by mx.google.com with ESMTPS id b5si7036230lah.17.2015.01.29.02.41.02 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:41:02 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.177 as permitted sender) client-ip=209.85.217.177; Received: by mail-lb0-f177.google.com with SMTP id p9so26557847lbv.8 for ; Thu, 29 Jan 2015 02:41:02 -0800 (PST) X-Received: by 10.152.5.226 with SMTP id v2mr13493475lav.34.1422528062745; Thu, 29 Jan 2015 02:41:02 -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 h5csp1719499lbj; Thu, 29 Jan 2015 02:41:02 -0800 (PST) X-Received: by 10.140.102.170 with SMTP id w39mr26qge.100.1422528061420; Thu, 29 Jan 2015 02:41:01 -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 m64si9700087qge.85.2015.01.29.02.41.00 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:41:01 -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 1YGmWw-0007NL-9L; Thu, 29 Jan 2015 10:40:58 +0000 Received: from mail-lb0-f179.google.com ([209.85.217.179]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YGmWN-0007Im-5r for lng-odp@lists.linaro.org; Thu, 29 Jan 2015 10:40:23 +0000 Received: by mail-lb0-f179.google.com with SMTP id 10so26519075lbg.10 for ; Thu, 29 Jan 2015 02:40:17 -0800 (PST) X-Received: by 10.152.184.231 with SMTP id ex7mr54429lac.4.1422528017442; Thu, 29 Jan 2015 02:40:17 -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.16 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 29 Jan 2015 02:40:16 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Thu, 29 Jan 2015 11:39:59 +0100 Message-Id: <1422528008-29845-8-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 07/16] 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.177 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_init.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/platform/linux-generic/include/api/odp_init.h b/platform/linux-generic/include/api/odp_init.h index ac856df..c862eae 100644 --- a/platform/linux-generic/include/api/odp_init.h +++ b/platform/linux-generic/include/api/odp_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);