diff options
| author | Péter Dimitrov <[email protected]> | 2019-04-25 09:57:12 +0200 |
|---|---|---|
| committer | Péter Dimitrov <[email protected]> | 2019-04-25 09:57:12 +0200 |
| commit | 71f6a4e4a3fb39fb2d90a31a00093c018ece328a (patch) | |
| tree | 76d260f102eb0a67ffd4d1120dd93738457ba199 /lib/ssl/doc/src/ssl.xml | |
| parent | a21ad3ee86e89ee8a73f6b9279e689eaae80376d (diff) | |
| parent | 2323f49b7d43213a7f54247b4b1b3d3a6d17ff76 (diff) | |
| download | otp-71f6a4e4a3fb39fb2d90a31a00093c018ece328a.tar.gz otp-71f6a4e4a3fb39fb2d90a31a00093c018ece328a.tar.bz2 otp-71f6a4e4a3fb39fb2d90a31a00093c018ece328a.zip | |
Merge branch 'peterdmv/ssl/enhance-documentation'
* peterdmv/ssl/enhance-documentation:
ssl: Refer documentation of HttpPacket from erts
ssl: Update type spec of ssl:suite_to_str/1
ssl: Update function ssl:eccs/1
Change-Id: I0ebbb5da595bd93e69165d8610cdaf479633f213
Diffstat (limited to 'lib/ssl/doc/src/ssl.xml')
| -rw-r--r-- | lib/ssl/doc/src/ssl.xml | 61 |
1 files changed, 7 insertions, 54 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 422bd6a19d..d626748af6 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -128,7 +128,7 @@ <name name="hostname"/> </datatype> - <datatype> + <datatype> <name name="ip_address"/> </datatype> @@ -137,26 +137,14 @@ </datatype> <datatype> - <name name="protocol_version_tuple"/> - </datatype> - - <datatype> <name name="tls_version"/> </datatype> <datatype> - <name name="tls_version_tuple"/> - </datatype> - - <datatype> <name name="dtls_version"/> </datatype> <datatype> - <name name="dtls_version_tuple"/> - </datatype> - - <datatype> <name name="tls_legacy_version"/> </datatype> @@ -264,46 +252,6 @@ <name name="reason"/> </datatype> - <datatype> - <name name="http_packet"/> - </datatype> - - <datatype> - <name name="http_request"/> - </datatype> - - <datatype> - <name name="http_response"/> - </datatype> - - <datatype> - <name name="http_header"/> - </datatype> - - <datatype> - <name name="http_error"/> - </datatype> - - <datatype> - <name name="http_method"/> - </datatype> - - <datatype> - <name name="http_uri"/> - </datatype> - - <datatype> - <name name="http_version"/> - </datatype> - - <datatype> - <name name="http_field"/> - </datatype> - - <datatype> - <name name="http_string"/> - </datatype> - <datatype_title>TLS/DTLS OPTION DESCRIPTIONS - COMMON for SERVER and CLIENT</datatype_title> <datatype> @@ -1507,6 +1455,11 @@ fun(srp, Username :: string(), UserState :: term()) -> <name since="" name="recv" arity="2" /> <name since="" name="recv" arity="3" /> <fsummary>Receives data on a socket.</fsummary> + <type_desc variable="HttpPacket">See the description of + <c>HttpPacket</c> in + <seealso marker="erts:erlang#decode_packet/3"><c>erlang:decode_packet/3</c></seealso> + in ERTS. + </type_desc> <desc> <p>Receives a packet from a socket in passive mode. A closed socket is indicated by return value @@ -1612,7 +1565,7 @@ fun(srp, Username :: string(), UserState :: term()) -> </func> <func> - <name since="OTP 21.0" name="suite_to_str" arity="1" /> + <name since="OTP 21.0" name="suite_to_str" arity="1" clause_i="1" /> <fsummary>Returns the string representation of a cipher suite.</fsummary> <desc> <p>Returns the string representation of a cipher suite.</p> |