From 218a6db09c97f1c4f194953b4b0a08fd0c02b9eb Mon Sep 17 00:00:00 2001 From: Jesper Louis Andersen Date: Mon, 10 Feb 2020 14:23:28 +0100 Subject: [PATCH] More documentation. --- src/enacl.erl | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/enacl.erl b/src/enacl.erl index c3cb393..25521b1 100644 --- a/src/enacl.erl +++ b/src/enacl.erl @@ -12,7 +12,10 @@ %%% application may result in severely reduced strength of the cryptography. Take some %%% time to make sure this is the case before using.

%%%

Note: All functions will fail with a `badarg' error if given incorrect -%%% parameters.

+%%% parameters. Also, if something is wrong internally, they will raise an error of +%%% the form `enacl_internal_error'. There is usually no way to continue gracefully +%%% from either of these. A third error is `enacl_finalized`, raised when you try +%%% re-using an already finalized state for multi-part messages.

%%% @end. -module(enacl).