From patchwork Mon Feb 2 17:20:46 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44171 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wg0-f71.google.com (mail-wg0-f71.google.com [74.125.82.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 693D92070C for ; Mon, 2 Feb 2015 17:21:47 +0000 (UTC) Received: by mail-wg0-f71.google.com with SMTP id y19sf17038625wgg.2 for ; Mon, 02 Feb 2015 09:21:46 -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=t3TvnhLbHrhE91e0wtnnXxGbrej69SJsgGfn0PoqEkI=; b=AtnhS7BJVgsU/tFi9y1LjiTI7FMUrvzI6zaF409wJxgmiOzHdqj3WvVsrbQMvDzYxF GvByREGgGWPqMjC42TDfdOckzmtIgh3o43raW8aMhQCvGJY6tm5Dj1DU1Cfzt0jVq7pj sCw7rL/vU8df4kpnEY8FC+vdci6emtmalaPyzm+H9nfv1AZtGJkymeuoCEX4v8giV7yr FRqDtvanff7PPP2dWOT7q2VV+T3o1gs1xGyv7kloRc689hdywQtjq6sEOlJnJwXWY92U 04HSeoAtrv3Hf3s3Gi9cKVbLehH0Xn2CBKvkxl7n1fwmLuRpzCpTrApUF8WBtXJZ34+Y CUEg== X-Gm-Message-State: ALoCoQkPH6s6AO1XA3Y8SYoSasP4OJQbnCl5xhTuaVykg3JcIkchHPkhAQEsT4YBMi9ytHBa5DKv X-Received: by 10.112.30.131 with SMTP id s3mr2605544lbh.13.1422897706650; Mon, 02 Feb 2015 09:21:46 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.8.49 with SMTP id o17ls675636laa.24.gmail; Mon, 02 Feb 2015 09:21:46 -0800 (PST) X-Received: by 10.112.129.195 with SMTP id ny3mr21047469lbb.10.1422897706507; Mon, 02 Feb 2015 09:21:46 -0800 (PST) Received: from mail-la0-f48.google.com (mail-la0-f48.google.com. [209.85.215.48]) by mx.google.com with ESMTPS id c6si5395305lag.104.2015.02.02.09.21.46 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 02 Feb 2015 09:21:46 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.48 as permitted sender) client-ip=209.85.215.48; Received: by mail-la0-f48.google.com with SMTP id pv20so43067046lab.7 for ; Mon, 02 Feb 2015 09:21:46 -0800 (PST) X-Received: by 10.152.203.230 with SMTP id kt6mr20103804lac.38.1422897706389; Mon, 02 Feb 2015 09:21:46 -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 h5csp1431330lbj; Mon, 2 Feb 2015 09:21:45 -0800 (PST) X-Received: by 10.170.121.17 with SMTP id n17mr9887325ykb.17.1422897705133; Mon, 02 Feb 2015 09:21:45 -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 x1si24991260qcd.36.2015.02.02.09.21.43 (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 02 Feb 2015 09:21:45 -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 1YIKgv-00073N-Qh; Mon, 02 Feb 2015 17:21:41 +0000 Received: from mail-la0-f41.google.com ([209.85.215.41]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIKgM-0006zC-0o for lng-odp@lists.linaro.org; Mon, 02 Feb 2015 17:21:06 +0000 Received: by mail-la0-f41.google.com with SMTP id gm9so43297877lab.0 for ; Mon, 02 Feb 2015 09:21:00 -0800 (PST) X-Received: by 10.152.19.194 with SMTP id h2mr20068491lae.77.1422897660503; Mon, 02 Feb 2015 09:21:00 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id rv1sm4530726lbb.25.2015.02.02.09.20.59 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 02 Feb 2015 09:20:59 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Mon, 2 Feb 2015 18:20:46 +0100 Message-Id: <1422897646-8064-9-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422897646-8064-1-git-send-email-ola.liljedahl@linaro.org> References: <1422897646-8064-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: crypto patch Subject: [lng-odp] [PATCHv3 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.48 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 e9530a3..0ee9d83 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,