aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc
diff options
context:
space:
mode:
authorPéter Dimitrov <[email protected]>2019-04-24 15:10:16 +0200
committerPéter Dimitrov <[email protected]>2019-04-24 15:10:16 +0200
commit2323f49b7d43213a7f54247b4b1b3d3a6d17ff76 (patch)
tree776c392d08621ba8ad219774c52ee6c7396e7c65 /lib/ssl/doc
parent3008d77a2c93b45c45da1739d63abf2f476ad490 (diff)
downloadotp-2323f49b7d43213a7f54247b4b1b3d3a6d17ff76.tar.gz
otp-2323f49b7d43213a7f54247b4b1b3d3a6d17ff76.tar.bz2
otp-2323f49b7d43213a7f54247b4b1b3d3a6d17ff76.zip
ssl: Refer documentation of HttpPacket from erts
Do not document http_packet() in ssl but refer to description of erlang:decode_packet/3. Change-Id: Ib2d0e4fc9605e40fe98bb249bc17fc39046d137a
Diffstat (limited to 'lib/ssl/doc')
-rw-r--r--lib/ssl/doc/src/ssl.xml45
1 files changed, 5 insertions, 40 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 27046a8434..d626748af6 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -252,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>
@@ -1495,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