diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-03-19 09:05:04 +0100 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-03-27 11:02:23 +0100 |
| commit | f6fb76683ef14043d6ff36394fccfd1e8b9d4928 (patch) | |
| tree | b397ecaab3aa07004ca124cda9804aea52852031 /lib/crypto/doc/src | |
| parent | 51235f2da7f107099e67cc9b0193ff5564b9702d (diff) | |
| download | erlang-f6fb76683ef14043d6ff36394fccfd1e8b9d4928.tar.gz | |
otp: Refactor type docs to always use <datatype>
If we want the types to be shown in the EEP-48 chunks
all types need to be documented as <datatype>.
Diffstat (limited to 'lib/crypto/doc/src')
| -rw-r--r-- | lib/crypto/doc/src/crypto.xml | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index d622143d2b..86e3f0158a 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -483,19 +483,15 @@ <datatype> <name name="srp_gen_params"/> <name name="srp_comp_params"/> - <desc> - <marker id="type-srp_user_gen_params"/> - <code>srp_user_gen_params() = [DerivedKey::binary(), Prime::binary(), Generator::binary(), Version::atom()]</code> - <marker id="type-srp_host_gen_params"/> - <code>srp_host_gen_params() = [Verifier::binary(), Prime::binary(), Version::atom() ]</code> - <marker id="type-srp_user_comp_params"/> - <code>srp_user_comp_params() = [DerivedKey::binary(), Prime::binary(), Generator::binary(), Version::atom() | ScramblerArg::list()]</code> - <marker id="type-srp_host_comp_params"/> - <code>srp_host_comp_params() = [Verifier::binary(), Prime::binary(), Version::atom() | ScramblerArg::list()]</code> - <p>Where Verifier is <c>v</c>, Generator is <c>g</c> and Prime is<c> N</c>, DerivedKey is <c>X</c>, and Scrambler is - <c>u</c> (optional will be generated if not provided) from <url href="http://srp.stanford.edu/design.html">SRP design</url> - Version = '3' | '6' | '6a' - </p> + <name>srp_user_gen_params() = [DerivedKey::binary(), Prime::binary(), Generator::binary(), Version::atom()]</name> + <name>srp_host_gen_params() = [Verifier::binary(), Prime::binary(), Version::atom() ]</name> + <name>srp_user_comp_params() = [DerivedKey::binary(), Prime::binary(), Generator::binary(), Version::atom() | ScramblerArg::list()]</name> + <name>srp_host_comp_params() = [Verifier::binary(), Prime::binary(), Version::atom() | ScramblerArg::list()]</name> + <desc> + <p>Where Verifier is <c>v</c>, Generator is <c>g</c> and Prime is<c> N</c>, DerivedKey is <c>X</c>, and Scrambler is + <c>u</c> (optional will be generated if not provided) from <url href="http://srp.stanford.edu/design.html">SRP design</url> + Version = '3' | '6' | '6a' + </p> </desc> </datatype> |