aboutsummaryrefslogtreecommitdiffstats
path: root/lib/crypto/doc
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2019-04-09 12:10:31 +0200
committerHans Nilsson <[email protected]>2019-04-11 13:02:30 +0200
commitdc4c62ca5220cfc8def7ec5275036c7fb7dc370d (patch)
tree3ac2e6a92b671589e8fb12a67d92a3c782debf81 /lib/crypto/doc
parent5c3a51b042806d7d953424948b6c65cbcde6900b (diff)
downloadotp-dc4c62ca5220cfc8def7ec5275036c7fb7dc370d.tar.gz
otp-dc4c62ca5220cfc8def7ec5275036c7fb7dc370d.tar.bz2
otp-dc4c62ca5220cfc8def7ec5275036c7fb7dc370d.zip
crypto: Rename crypto_aead to crypto_one_time_aead
Diffstat (limited to 'lib/crypto/doc')
-rw-r--r--lib/crypto/doc/src/crypto.xml4
-rw-r--r--lib/crypto/doc/src/new_api.xml6
2 files changed, 5 insertions, 5 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index db53eed738..d607679ff5 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -754,8 +754,8 @@
</func>
<func>
- <name name="crypto_aead" arity="6" since="OTP 22.0"/>
- <name name="crypto_aead" arity="7" since="OTP 22.0"/>
+ <name name="crypto_one_time_aead" arity="6" since="OTP 22.0"/>
+ <name name="crypto_one_time_aead" arity="7" since="OTP 22.0"/>
<fsummary>Do a complete encrypt or decrypt with an AEAD cipher of the full text</fsummary>
<desc>
<p>Part of the <seealso marker="crypto:new_api#the-new-api">new API</seealso>.
diff --git a/lib/crypto/doc/src/new_api.xml b/lib/crypto/doc/src/new_api.xml
index e5e108d973..7b062310f2 100644
--- a/lib/crypto/doc/src/new_api.xml
+++ b/lib/crypto/doc/src/new_api.xml
@@ -71,14 +71,14 @@
<list>
<item><seealso marker="crypto#crypto_one_time/4">crypto_one_time/4</seealso></item>
<item><seealso marker="crypto#crypto_one_time/5">crypto_one_time/5</seealso></item>
- <item><seealso marker="crypto#crypto_aead/6">crypto_aead/6</seealso></item>
- <item><seealso marker="crypto#crypto_aead/7">crypto_aead/7</seealso></item>
+ <item><seealso marker="crypto#crypto_one_time_aead/6">crypto_one_time_aead/6</seealso></item>
+ <item><seealso marker="crypto#crypto_one_time_aead/7">crypto_one_time_aead/7</seealso></item>
</list>
<p>In those functions the internal crypto state is first created and initialized
with the cipher type, the key and possibly other data. Then the data is encrypted or decrypted,
the crypto state is de-allocated and the result of the crypto operation is returned.
</p>
- <p>The <c>crypto_aead</c> functions are for the ciphers of mode <c>ccm</c> or
+ <p>The <c>crypto_one_time_aead</c> functions are for the ciphers of mode <c>ccm</c> or
<c>gcm</c>, and for the cipher <c>chacha20-poly1305</c>.
</p>
<p>For repeated encryption or decryption of a text divided in parts, where the internal