summaryrefslogtreecommitdiff
path: root/lib/crypto/doc/src/crypto.xml
diff options
context:
space:
mode:
authorHans Nilsson <hans@erlang.org>2022-03-08 14:04:27 +0100
committerHans Nilsson <hans@erlang.org>2022-03-21 06:53:20 +0100
commitc8c06de384357ffeda82c6184d8682ded290128a (patch)
tree240151431d2db012a27af3cfdb603f891d99ee54 /lib/crypto/doc/src/crypto.xml
parent814234aa91b52b744bb7251b15a6e4b19df4e05d (diff)
downloaderlang-c8c06de384357ffeda82c6184d8682ded290128a.tar.gz
crypto:hash*/*: error:ERR -> error:{ERR,FileInfo,Description}
Diffstat (limited to 'lib/crypto/doc/src/crypto.xml')
-rw-r--r--lib/crypto/doc/src/crypto.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 34abbfa279..d8d26fffb0 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -1078,9 +1078,8 @@ end
<name name="hash" arity="2" since="OTP R15B02"/>
<fsummary></fsummary>
<desc>
+ <p>Uses the <seeerl marker="#error_3tup">3-tuple style</seeerl> for error handling.</p>
<p>Computes a message digest of type <c>Type</c> from <c>Data</c>.</p>
- <p>May raise exception <c>error:notsup</c> in case the chosen <c>Type</c>
- is not supported by the underlying libcrypto implementation.</p>
</desc>
</func>
@@ -1088,11 +1087,10 @@ end
<name name="hash_init" arity="1" since="OTP R15B02"/>
<fsummary></fsummary>
<desc>
+ <p>Uses the <seeerl marker="#error_3tup">3-tuple style</seeerl> for error handling.</p>
<p>Initializes the context for streaming hash operations. <c>Type</c> determines
which digest to use. The returned context should be used as argument
to <seemfa marker="#hash_update/2">hash_update</seemfa>.</p>
- <p>May raise exception <c>error:notsup</c> in case the chosen <c>Type</c>
- is not supported by the underlying libcrypto implementation.</p>
</desc>
</func>
@@ -1100,6 +1098,7 @@ end
<name name="hash_update" arity="2" since="OTP R15B02"/>
<fsummary></fsummary>
<desc>
+ <p>Uses the <seeerl marker="#error_3tup">3-tuple style</seeerl> for error handling.</p>
<p>Updates the digest represented by <c>Context</c> using the given <c>Data</c>. <c>Context</c>
must have been generated using <seemfa marker="#hash_init/1">hash_init</seemfa>
or a previous call to this function. <c>Data</c> can be any length. <c>NewContext</c>
@@ -1112,6 +1111,7 @@ end
<name name="hash_final" arity="1" since="OTP R15B02"/>
<fsummary></fsummary>
<desc>
+ <p>Uses the <seeerl marker="#error_3tup">3-tuple style</seeerl> for error handling.</p>
<p>Finalizes the hash operation referenced by <c>Context</c> returned
from a previous call to <seemfa marker="#hash_update/2">hash_update</seemfa>.
The size of <c>Digest</c> is determined by the type of hash