Skip to content

Commit a2fa80e

Browse files
committed
crypto: Clarify docs for crypto_one_time_aead/6
1 parent 2b53202 commit a2fa80e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

lib/crypto/src/crypto.erl

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1742,7 +1742,14 @@ crypto_one_time(Cipher, Key, IV, Data, FlagOrOptions) ->
17421742
{}).
17431743

17441744
%%%----------------------------------------------------------------
1745-
-doc(#{equiv => crypto_one_time_aead/7}).
1745+
-doc """
1746+
Do a complete encrypt with an AEAD cipher of the full text
1747+
with the default tag length.
1748+
1749+
Equivalent to
1750+
`crypto_one_time_aead(Cipher, Key, IV, InText, AAD, TagLength, true)`
1751+
where `TagLength` is the default tag length for the given `Cipher`.
1752+
""".
17461753
-doc(#{group => <<"Cipher API">>,
17471754
since => <<"OTP 22.0">>}).
17481755
-spec crypto_one_time_aead(Cipher, Key, IV, InText, AAD, EncFlag::true) ->

0 commit comments

Comments
 (0)