aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2019-03-21 14:24:29 +0100
committerHans Nilsson <[email protected]>2019-03-22 10:23:46 +0100
commit89236bc46fd3a7de0dbb9df2390c30e7333f6bdb (patch)
tree04d4ebed874416a015f3bc6244c6711daebb2b0a
parent7cb7cd54f3000c08c925f2ad10723b54efdc485e (diff)
downloadotp-89236bc46fd3a7de0dbb9df2390c30e7333f6bdb.tar.gz
otp-89236bc46fd3a7de0dbb9df2390c30e7333f6bdb.tar.bz2
otp-89236bc46fd3a7de0dbb9df2390c30e7333f6bdb.zip
crypto: Declare *_info return map and other review-comments
Conflicts: lib/crypto/doc/src/crypto.xml
-rw-r--r--lib/crypto/doc/src/crypto.xml34
1 files changed, 32 insertions, 2 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 17522bcdab..251263714d 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -562,6 +562,36 @@
</desc>
</datatype>
+ <datatype>
+ <name name="descriptive_error"/>
+ <desc>
+ <p>This is a more developed variant of the older
+ <seealso marker="#type-run_time_error">run_time_error()</seealso>.
+ </p>
+ <p>It is like the older type an exception of the <c>error</c> class. In addition they contain
+ a descriptive text in English. That text is targeted to a developer. Examples are "Bad key size"
+ or "Cipher id is not an atom".
+ </p>
+ <p>The exceptions are:</p>
+ <taglist>
+ <tag><c>{badarg, Description::string()}</c></tag>
+ <item><p>Signifies that one or more arguments are of wrong data type or are otherwise badly formed.</p>
+ </item>
+
+ <tag><c>{notsup, Description::string()}</c></tag>
+ <item><p>Signifies that the algorithm is known but is not supported by current underlying libcrypto
+ or explicitly disabled when building that one.</p>
+ </item>
+
+ <tag><c>{error, Description::string()}</c></tag>
+ <item><p>An error condition that should not occur, for example a memory allocation failed or
+ the underlying cryptolib returned an error code, for example "Can't initialize context, step 1".
+ Thoose text usually needs searching the C-code to be understood.</p>
+ </item>
+ </taglist>
+ </desc>
+ </datatype>
+
</datatypes>
<!--================ FUNCTIONS ================-->
@@ -873,7 +903,7 @@
<fsummary>Information about supported hash algorithms.</fsummary>
<desc>
<p>Provides a map with information about block_size, size and possibly other properties of the
- hash algorithm in the argument.
+ hash algorithm in question.
</p>
<p>For a list of supported hash algorithms, see <seealso marker="#supports-0">supports/0</seealso>.
</p>
@@ -885,7 +915,7 @@
<fsummary>Information about supported ciphers.</fsummary>
<desc>
<p>Provides a map with information about block_size, key_length, iv_length and possibly other properties of the
- cipher algorithm in the argument.
+ cipher algorithm in question.
</p>
<p>For a list of supported cipher algorithms, see <seealso marker="#supports-0">supports/0</seealso>.
</p>