aboutsummaryrefslogtreecommitdiffstats
path: root/lib/crypto/doc
diff options
context:
space:
mode:
authorRaimo Niskanen <[email protected]>2017-04-03 12:29:23 +0200
committerRaimo Niskanen <[email protected]>2017-04-04 09:19:30 +0200
commite1a74e3077ca870520a748f29dd7c4b9115ce090 (patch)
treeff9063700120d86092a09e2b42199f9e15f549c0 /lib/crypto/doc
parentc84e541b78cb9ee63a02db2240903ddd6131793a (diff)
downloadotp-e1a74e3077ca870520a748f29dd7c4b9115ce090.tar.gz
otp-e1a74e3077ca870520a748f29dd7c4b9115ce090.tar.bz2
otp-e1a74e3077ca870520a748f29dd7c4b9115ce090.zip
Clean up documentation and test cases
Diffstat (limited to 'lib/crypto/doc')
-rw-r--r--lib/crypto/doc/src/crypto.xml35
1 files changed, 21 insertions, 14 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 30835a8447..552d95d7dc 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -732,14 +732,17 @@
<func>
<name>rand_seed() -> rand:state()</name>
- <fsummary>Strong random number generation plugin state</fsummary>>
- <desc>
- Creates state object for <seealso marker="stdlib:rand">random number generation</seealso>,
- in order to generate cryptographically strong random numbers
- (based on OpenSSL's <c>BN_rand_range</c>),
- and saves it on process dictionary before returning it as well.
- See also <seealso marker="stdlib:rand#seed-1">rand:seed/1</seealso>
-
+ <fsummary>Strong random number generation plugin state</fsummary>
+ <desc>
+ <p>
+ Creates state object for
+ <seealso marker="stdlib:rand">random number generation</seealso>,
+ in order to generate cryptographically strong random numbers
+ (based on OpenSSL's <c>BN_rand_range</c>),
+ and saves it on process dictionary before returning it as well.
+ See also
+ <seealso marker="stdlib:rand#seed-1">rand:seed/1</seealso>.
+ </p>
<p><em>Example</em></p>
<pre>
_ = crypto:rand_seed(),
@@ -750,12 +753,16 @@ _FloatValue = rand:uniform(). % [0.0; 1.0[</pre>
<func>
<name>rand_seed_s() -> rand:state()</name>
- <fsummary>Strong random number generation plugin state</fsummary>>
- <desc>
- Creates state object for <seealso marker="stdlib:rand">random number generation</seealso>,
- in order to generate cryptographically strongly random numbers
- (based on OpenSSL's <c>BN_rand_range</c>).
- See also <seealso marker="stdlib:rand#seed_s-1">rand:seed_s/1</seealso>
+ <fsummary>Strong random number generation plugin state</fsummary>
+ <desc>
+ <p>
+ Creates state object for
+ <seealso marker="stdlib:rand">random number generation</seealso>,
+ in order to generate cryptographically strongly random numbers
+ (based on OpenSSL's <c>BN_rand_range</c>).
+ See also
+ <seealso marker="stdlib:rand#seed_s-1">rand:seed_s/1</seealso>.
+ </p>
</desc>
</func>