diff options
| author | Hans Nilsson <[email protected]> | 2019-05-03 11:54:41 +0200 |
|---|---|---|
| committer | Hans Nilsson <[email protected]> | 2019-05-03 11:54:41 +0200 |
| commit | 8d107e535226e2ce6af97a10a9c71352da47e307 (patch) | |
| tree | ef854a0fb15ffcecf982f48907d694411be1f008 /lib/crypto/doc/src/crypto.xml | |
| parent | 627ce4fc5425688840a5db4f1085a923c6503571 (diff) | |
| parent | 938e788fb404e9e270975d36db5e27d7e136ef09 (diff) | |
| download | otp-8d107e535226e2ce6af97a10a9c71352da47e307.tar.gz otp-8d107e535226e2ce6af97a10a9c71352da47e307.tar.bz2 otp-8d107e535226e2ce6af97a10a9c71352da47e307.zip | |
Merge branch 'hans/crypto/new_supports_1/OTP-15771'
* hans/crypto/new_supports_1/OTP-15771:
crypto: Document supports/1
Diffstat (limited to 'lib/crypto/doc/src/crypto.xml')
| -rw-r--r-- | lib/crypto/doc/src/crypto.xml | 40 |
1 files changed, 28 insertions, 12 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 641738247e..751cf9d1fc 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -772,6 +772,19 @@ </p> </desc> </func> + + <func> + <name name="supports" arity="1" since="OTP 22.0"/> + <fsummary>Provide a list of available crypto algorithms.</fsummary> + <desc> + <p> Can be used to determine which crypto algorithms that are supported + by the underlying libcrypto library</p> + <p>See <seealso marker="#hash_info-1">hash_info/1</seealso> and <seealso marker="#cipher_info-1">cipher_info/1</seealso> + for information about the hash and cipher algorithms. + </p> + </desc> + </func> + </funcs> <section> @@ -1425,18 +1438,6 @@ FloatValue = rand:uniform(). % again </desc> </func> - <func> - <name name="supports" arity="0" since="OTP R16B01"/> - <fsummary>Provide a list of available crypto algorithms.</fsummary> - <desc> - <p> Can be used to determine which crypto algorithms that are supported - by the underlying libcrypto library</p> - <p>See <seealso marker="#hash_info-1">hash_info/1</seealso> and <seealso marker="#cipher_info-1">cipher_info/1</seealso> - for information about the hash and cipher algorithms. - </p> - </desc> - </func> - <func> <name name="ec_curves" arity="0" since="OTP 17.0"/> <fsummary>Provide a list of available named elliptic curves.</fsummary> @@ -1947,6 +1948,21 @@ FloatValue = rand:uniform(). % again </desc> </func> + <func> + <name name="supports" arity="0" since="OTP R16B01"/> + <fsummary>Provide a list of available crypto algorithms.</fsummary> + <desc> + <dont><p>Don't use this function for new programs! Use + <seealso marker="crypto#supports-1">supports/1</seealso> in + <seealso marker="crypto:new_api">the new api</seealso>.</p></dont> + <p> Can be used to determine which crypto algorithms that are supported + by the underlying libcrypto library</p> + <p>See <seealso marker="#hash_info-1">hash_info/1</seealso> and <seealso marker="#cipher_info-1">cipher_info/1</seealso> + for information about the hash and cipher algorithms. + </p> + </desc> + </func> + </funcs> |