QPQ-AG/enacl
10
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small documentation fixups

Browse Source
This commit is contained in:
Jesper Louis Andersen 2021-06-15 13:03:30 +02:00
parent 7f06675533
commit 0855ce2f55
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/enacl.erl
View File

@ -1222,7 +1222,7 @@ kx_SECRETKEYBYTES() ->
%% ---------------------- %% ----------------------
%% @doc aead_chacha20poly1305_encrypt/4 encrypts `Message' with additional data %% @doc aead_chacha20poly1305_encrypt/4 encrypts `Message' with additional data
%% `AD' using `Key' and `Nonce'. Returns the encrypted message followed by %% `AD' using `Key' and `Nonce'. Returns the encrypted message followed by
%% `aead_chacha20poly1305_ABYTES/0' bytes of MAC. %% aead_chacha20poly1305_ABYTES/0 bytes of MAC.
%% @end %% @end
-spec aead_chacha20poly1305_ietf_encrypt(Msg, AD, Nonce, Key) -> binary() -spec aead_chacha20poly1305_ietf_encrypt(Msg, AD, Nonce, Key) -> binary()
when Key :: binary(), when Key :: binary(),
@ -1234,7 +1234,7 @@ aead_chacha20poly1305_ietf_encrypt(Msg, AD, Nonce, Key) ->
%% @doc aead_chacha20poly1305_decrypt/4 decrypts ciphertext `CT' with additional %% @doc aead_chacha20poly1305_decrypt/4 decrypts ciphertext `CT' with additional
%% data `AD' using `Key' and `Nonce'. Note: `CipherText' should contain %% data `AD' using `Key' and `Nonce'. Note: `CipherText' should contain
%% `aead_chacha20poly1305_ABYTES/0' bytes that is the MAC. Returns the decrypted %% aead_chacha20poly1305_ABYTES/0 bytes that is the MAC. Returns the decrypted
%% message. %% message.
%% @end %% @end
-spec aead_chacha20poly1305_ietf_decrypt(CT, AD, Nonce, Key) -> binary() | {error, term()} -spec aead_chacha20poly1305_ietf_decrypt(CT, AD, Nonce, Key) -> binary() | {error, term()}