diff options
| author | Hans Nilsson <[email protected]> | 2017-03-09 15:25:21 +0100 |
|---|---|---|
| committer | Hans Nilsson <[email protected]> | 2017-03-09 15:42:28 +0100 |
| commit | c6270678e0c4297440c2b191ad500b33ed18af5f (patch) | |
| tree | 38878a6c03617e580bd9ebdfaa28da84e0a01095 /lib/crypto/doc | |
| parent | 7c8bcb4ea083d2c4c9893fc0597528c39b5f845c (diff) | |
| download | otp-c6270678e0c4297440c2b191ad500b33ed18af5f.tar.gz otp-c6270678e0c4297440c2b191ad500b33ed18af5f.tar.bz2 otp-c6270678e0c4297440c2b191ad500b33ed18af5f.zip | |
crypto: Document exceptions thrown in crypto:generate_key
Diffstat (limited to 'lib/crypto/doc')
| -rw-r--r-- | lib/crypto/doc/src/crypto.xml | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 440c5bd204..3192ec0de8 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -312,13 +312,17 @@ <desc> <p>Generates a public key of type <c>Type</c>. See also <seealso marker="public_key:public_key#generate_key-1">public_key:generate_key/1</seealso>. - May throw exception <c>low_entropy</c> in case the random generator - failed due to lack of secure "randomness". - </p> + May throw exception an exception of class <c>error</c>: + </p> + <list type="bulleted"> + <item><c>badarg</c>: an argument is of wrong type or has an illegal value,</item> + <item><c>low_entropy</c>: the random generator failed due to lack of secure "randomness",</item> + <item><c>computation_failed</c>: the computation fails of another reason than <c>low_entropy</c>.</item> + </list> <note> <p>RSA key generation is only available if the runtime was built with dirty scheduler support. Otherwise, attempting to - generate an RSA key will throw exception <c>notsup</c>.</p> + generate an RSA key will throw exception <c>error:notsup</c>.</p> </note> </desc> </func> |