From patchwork Tue Feb 3 14:53:21 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44246 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-we0-f198.google.com (mail-we0-f198.google.com [74.125.82.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id D59EA2034D for ; Tue, 3 Feb 2015 14:55:30 +0000 (UTC) Received: by mail-we0-f198.google.com with SMTP id q59sf21281887wes.1 for ; Tue, 03 Feb 2015 06:55:30 -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=g6U6gJx9x/qNbiS9Hhi47rixmPPCAbGMRucryxRT1FrlKOA0O5+hMuuex5NT28FsUz Rbmix/zWUhCkwgHBxfNYyXjtI0lDbQ8nI+82GhEGX4wYJJMYdj9u+fYanvYvJuknLDeq 4gOz/qFEksUe+4INdCXb6OR1opNG36Sm/hWywnlD3qj+WdeGJ4C5g6wP5hEhTi35elVE YfvmWRATdPEjrybOWqW7SjBdfP5fql5nERac1G8ZKtbXrX837R2r0J0hfdKa7MbqgRRS Jla8DsC6phQIw8PlSIsmPlbqR8Tru4MYrTQYFkHZOzsBabs2198MRji6ZCuNUK8WkgvM ZMXw== X-Gm-Message-State: ALoCoQkFBTk/SahnjiEDT1FIwO02QbTXUvHcEgPDsGlkxfJKWayB6fY/pKYCWYOy5TtFPDGHTBHe X-Received: by 10.112.30.131 with SMTP id s3mr3245765lbh.13.1422975330145; Tue, 03 Feb 2015 06:55:30 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.5.74 with SMTP id q10ls754769laq.43.gmail; Tue, 03 Feb 2015 06:55:30 -0800 (PST) X-Received: by 10.152.21.10 with SMTP id r10mr24849075lae.11.1422975329970; Tue, 03 Feb 2015 06:55:29 -0800 (PST) Received: from mail-la0-f41.google.com (mail-la0-f41.google.com. [209.85.215.41]) by mx.google.com with ESMTPS id ns6si9814015lbb.76.2015.02.03.06.55.29 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 03 Feb 2015 06:55:29 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.41 as permitted sender) client-ip=209.85.215.41; Received: by mail-la0-f41.google.com with SMTP id gm9so52606092lab.0 for ; Tue, 03 Feb 2015 06:55:29 -0800 (PST) X-Received: by 10.112.125.41 with SMTP id mn9mr24675480lbb.80.1422975329754; Tue, 03 Feb 2015 06:55:29 -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 h5csp1988568lbj; Tue, 3 Feb 2015 06:55:29 -0800 (PST) X-Received: by 10.140.98.212 with SMTP id o78mr18897741qge.81.1422975328442; Tue, 03 Feb 2015 06:55:28 -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 g43si29121500qge.6.2015.02.03.06.55.27 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 03 Feb 2015 06:55:28 -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 1YIesv-0001qk-Cq; Tue, 03 Feb 2015 14:55:25 +0000 Received: from mail-la0-f49.google.com ([209.85.215.49]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YIerP-0001ZV-Km for lng-odp@lists.linaro.org; Tue, 03 Feb 2015 14:53:51 +0000 Received: by mail-la0-f49.google.com with SMTP id gf13so52321943lab.8 for ; Tue, 03 Feb 2015 06:53:46 -0800 (PST) X-Received: by 10.112.172.167 with SMTP id bd7mr25161669lbc.14.1422975226066; Tue, 03 Feb 2015 06:53:46 -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.45 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 03 Feb 2015 06:53:45 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Tue, 3 Feb 2015 15:53:21 +0100 Message-Id: <1422975201-3364-19-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: crypto patch Subject: [lng-odp] [PATCHv4 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.41 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,