diff options
| author | Micael Karlberg <[email protected]> | 2018-10-09 16:32:31 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2018-10-09 16:32:31 +0200 |
| commit | ce28d70c686f342fb04fc05e1d00501e7cfbf213 (patch) | |
| tree | 3c09432251b6b244b32244646ec12fb04afcc993 /erts/doc/src/socket.xml | |
| parent | 789d5cefd0f710fd83dec27ad2239ea299737a49 (diff) | |
| download | otp-ce28d70c686f342fb04fc05e1d00501e7cfbf213.tar.gz otp-ce28d70c686f342fb04fc05e1d00501e7cfbf213.tar.bz2 otp-ce28d70c686f342fb04fc05e1d00501e7cfbf213.zip | |
[socket-nif|doc] Add preliminary doc for the function supports
Added preliminary documentation for the function socket:supports/0,1,2,3.
It still does not generate proper doc for supports/3 (the last
arg, Opt, don't get a type).
OTP-14831
Diffstat (limited to 'erts/doc/src/socket.xml')
| -rw-r--r-- | erts/doc/src/socket.xml | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml index af7e0ca9c1..49c14869bf 100644 --- a/erts/doc/src/socket.xml +++ b/erts/doc/src/socket.xml @@ -205,6 +205,27 @@ <datatype> <name name="int32"/> </datatype> + <datatype> + <name name="supports_options_socket"/> + </datatype> + <datatype> + <name name="supports_options_ip"/> + </datatype> + <datatype> + <name name="supports_options_ipv6"/> + </datatype> + <datatype> + <name name="supports_options_tcp"/> + </datatype> + <datatype> + <name name="supports_options_udp"/> + </datatype> + <datatype> + <name name="supports_options_sctp"/> + </datatype> + <datatype> + <name name="supports_options"/> + </datatype> </datatypes> <funcs> @@ -511,6 +532,34 @@ </desc> </func> + <func> + <name name="supports" arity="0"/> + <name name="supports" arity="1" clause_i="1"/> + <name name="supports" arity="1" clause_i="2"/> + <name name="supports" arity="1" clause_i="3"/> + <name name="supports" arity="1" clause_i="4"/> + <name name="supports" arity="2" clause_i="1"/> + <name name="supports" arity="2" clause_i="2"/> + <name name="supports" arity="2" clause_i="3"/> + <name name="supports" arity="2" clause_i="4"/> + <name name="supports" arity="2" clause_i="5"/> + <name name="supports" arity="2" clause_i="6"/> + <name name="supports" arity="2" clause_i="7"/> + <name name="supports" arity="3" clause_i="1"/> + <name name="supports" arity="3" clause_i="2"/> + <name name="supports" arity="3" clause_i="3"/> + <name name="supports" arity="3" clause_i="4"/> + <name name="supports" arity="3" clause_i="5"/> + <name name="supports" arity="3" clause_i="6"/> + <name name="supports" arity="3" clause_i="7"/> + <fsummary>Report info about what the platform supports.</fsummary> + <desc> + <p>This function intends to retreive information about what the + platform supports. Such as if SCTP is supported. Or which socket + options are supported. </p> + </desc> + </func> + </funcs> <section> <title>Examples</title> |