From patchwork Tue Feb 3 16:48:28 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44274 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f200.google.com (mail-wi0-f200.google.com [209.85.212.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 13C2E2034D for ; Tue, 3 Feb 2015 16:50:11 +0000 (UTC) Received: by mail-wi0-f200.google.com with SMTP id fb4sf26494683wid.3 for ; Tue, 03 Feb 2015 08:50:10 -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=ph4C8Rd6xKwfKF7q0MByJppeccBt0fHBjSnwpU/Hy/k=; b=X+caKQuaXNkx9fr2XIsMSoHyQh/Iccwtw1cbuYOIzEk7vlFr0rVMoJ7G2V1Xm2PzBO 4msSVUHqtth/EWo8+LSi0/7iF9w6pc3KiErefD1BH7pEnV75zME3f7rDg73gNfwAaxif 1utqZ/BvrOLhnRaYjQiNQiwg6wYjr7/5OsDnNeydTWQmkAvDACd1LxAnJ1YXwVM6YHgZ xH+gjlwuP1lXYiHhL2W8vtvB4Gfzx3p+M3GrG+1FGg2rQ/19gKTJEsgW5N3LZlmxcHgZ TKtRoyOb6iVgN8Av5Q+3IuSYS89MjSFgCOOZZqgmRmGtXWg1c6Un9yTdedburEOv5iQl mnkg== X-Gm-Message-State: ALoCoQmx+0XrOuroZwgxFY1ogPO3m0YzYSelJdAFGCC1rnqG1LL8kxF/KBv1R+3OfTA6o9i1z+oW X-Received: by 10.112.175.10 with SMTP id bw10mr3296968lbc.7.1422982210201; Tue, 03 Feb 2015 08:50:10 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.5.105 with SMTP id r9ls211314lar.8.gmail; Tue, 03 Feb 2015 08:50:10 -0800 (PST) X-Received: by 10.152.185.72 with SMTP id fa8mr25435146lac.73.1422982210053; Tue, 03 Feb 2015 08:50:10 -0800 (PST) Received: from mail-la0-f47.google.com (mail-la0-f47.google.com. [209.85.215.47]) by mx.google.com with ESMTPS id e10si19633153lbp.129.2015.02.03.08.50.10 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:50:10 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.47 as permitted sender) client-ip=209.85.215.47; Received: by mail-la0-f47.google.com with SMTP id hz20so53327436lab.6 for ; Tue, 03 Feb 2015 08:50:10 -0800 (PST) X-Received: by 10.112.144.164 with SMTP id sn4mr20435944lbb.2.1422982209950; Tue, 03 Feb 2015 08:50:09 -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 h5csp2058957lbj; Tue, 3 Feb 2015 08:50:09 -0800 (PST) X-Received: by 10.140.44.34 with SMTP id f31mr41030048qga.3.1422982208310; Tue, 03 Feb 2015 08:50:08 -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 e37si29364176qgd.75.2015.02.03.08.50.06 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 08:50:08 -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 1YIgfs-0008NH-Nb; Tue, 03 Feb 2015 16:50:04 +0000 Received: from mail-lb0-f177.google.com ([209.85.217.177]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIgeo-000887-Aw for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 16:48:58 +0000 Received: by mail-lb0-f177.google.com with SMTP id p9so39714741lbv.8 for ; Tue, 03 Feb 2015 08:48:52 -0800 (PST) X-Received: by 10.112.235.194 with SMTP id uo2mr25334485lbc.57.1422982132783; Tue, 03 Feb 2015 08:48:52 -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.51 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 08:48:51 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 17:48:28 +0100 Message-Id: <1422982108-13813-19-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: crypto patch Subject: [lng-odp] [PATCHv5 18/18] api: odp_crypto.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.47 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/crypto.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/odp/api/crypto.h b/include/odp/api/crypto.h index 1e15775..24b5512 100644 --- a/include/odp/api/crypto.h +++ b/include/odp/api/crypto.h @@ -265,7 +265,8 @@ typedef struct odp_crypto_op_result { * @param session Created session else ODP_CRYPTO_SESSION_INVALID * @param status Failure code if unsuccessful * - * @return 0 if successful else -1 + * @retval 0 on success + * @retval <0 on failure */ int odp_crypto_session_create(odp_crypto_session_params_t *params, @@ -314,7 +315,8 @@ odp_crypto_compl_free(odp_crypto_compl_t completion_event); * @param posted Pointer to return posted, TRUE for async operation * @param result Results of operation (when posted returns FALSE) * - * @return 0 if successful else -1 + * @retval 0 on success + * @retval <0 on failure */ int odp_crypto_operation(odp_crypto_op_params_t *params,