diff options
| author | Ingela Anderton Andin <[email protected]> | 2018-09-10 11:19:42 +0200 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2019-02-05 14:43:48 +0100 |
| commit | e042afe54727ae490d47eae47c6d9a210f04dd47 (patch) | |
| tree | 7999d1adfd7226d276903737cce6104a7230f4d2 /lib/ssl/doc/src/ssl_crl_cache.xml | |
| parent | 949c725abcc649e508d971cbc82f5278e050db2c (diff) | |
| download | otp-e042afe54727ae490d47eae47c6d9a210f04dd47.tar.gz otp-e042afe54727ae490d47eae47c6d9a210f04dd47.tar.bz2 otp-e042afe54727ae490d47eae47c6d9a210f04dd47.zip | |
ssl: Use specs to generate type documentation
Diffstat (limited to 'lib/ssl/doc/src/ssl_crl_cache.xml')
| -rw-r--r-- | lib/ssl/doc/src/ssl_crl_cache.xml | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/lib/ssl/doc/src/ssl_crl_cache.xml b/lib/ssl/doc/src/ssl_crl_cache.xml index b766cfd2d9..a33aec62a7 100644 --- a/lib/ssl/doc/src/ssl_crl_cache.xml +++ b/lib/ssl/doc/src/ssl_crl_cache.xml @@ -34,15 +34,27 @@ the following functions are available. </p> </description> + + <datatypes> + <datatype_title>DATA TYPES</datatype_title> + + <datatype> + <name name="crl_src"/> + </datatype> + + <datatype> + <name name="uri"/> + </datatype> + + </datatypes> <funcs> <func> <name since="OTP 18.0">delete(Entries) -> ok | {error, Reason} </name> <fsummary> </fsummary> <type> - <v> Entries = <seealso marker="stdlib:uri_string">uri_string:uri_string()</seealso> | {file, string()} | {der, [<seealso - marker="public_key:public_key"> public_key:der_encoded() </seealso>]}</v> - <v> Reason = term()</v> + <v> Entries = <seealso marker="#type-crl_src">crl_src()</seealso>]}</v> + <v> Reason = crl_reason()</v> </type> <desc> <p>Delete CRLs from the ssl applications local cache. </p> @@ -53,13 +65,12 @@ <name since="OTP 18.0">insert(URI, CRLSrc) -> ok | {error, Reason}</name> <fsummary> </fsummary> <type> - <v> CRLSrc = {file, string()} | {der, [ <seealso - marker="public_key:public_key"> public_key:der_encoded() </seealso> ]}</v> - <v> URI = <seealso marker="stdlib:uri_string">uri_string:uri_string() </seealso> </v> + <v> CRLSrc = <seealso marker="#type-crl_src">crl_src()</seealso>]}</v> + <v> URI = <seealso marker="#type-uri">uri()</seealso> </v> <v> Reason = term()</v> </type> <desc> - <p>Insert CRLs into the ssl applications local cache. </p> + <p>Insert CRLs, available to fetch on DER format from <c>URI</c>, into the ssl applications local cache. </p> </desc> </func> </funcs> |