diff options
author | Micael Karlberg <bmk@erlang.org> | 2021-08-05 16:23:55 +0200 |
---|---|---|
committer | Micael Karlberg <bmk@erlang.org> | 2021-08-30 16:41:16 +0200 |
commit | 5191ecfece28a6577d42b4ee0ee6c2c7bba8114c (patch) | |
tree | 2a4d56fef12c2caa0e9024ac2b57e39aa50e61d7 /lib/megaco | |
parent | 3294346971dfd28a29da8b6c0a29b7404976bd8f (diff) | |
download | erlang-5191ecfece28a6577d42b4ee0ee6c2c7bba8114c.tar.gz |
[megaco|doc] Improved documentation for (udp) open and (tcp) connect
Improved documentation for the megaco_udp:open and megaco_tcp:connect
functions.
OTP-17533
Diffstat (limited to 'lib/megaco')
-rw-r--r-- | lib/megaco/doc/src/megaco_tcp.xml | 33 | ||||
-rw-r--r-- | lib/megaco/doc/src/megaco_udp.xml | 33 |
2 files changed, 46 insertions, 20 deletions
diff --git a/lib/megaco/doc/src/megaco_tcp.xml b/lib/megaco/doc/src/megaco_tcp.xml index 93db0728be..eee44ef7f2 100644 --- a/lib/megaco/doc/src/megaco_tcp.xml +++ b/lib/megaco/doc/src/megaco_tcp.xml @@ -71,19 +71,36 @@ <type> <v>TransportRef = pid() | regname()</v> <v>OptionList = [Option]</v> - <v>Option = {host, Ipaddr} | {port, integer()} | {options, list()} | {receive_handle, term()} | {module, atom()} | {inet_backend, default | inet | socket}</v> + <v>Option = {host, IpAddr} | + {port, integer()} | + {options, list()} | + {receive_handle, term()} | + {module, atom()} | + {inet_backend, default | inet | socket}</v> <v>Handle = socket_handle()</v> <v>ControlPid = pid()</v> <v>Reason = term()</v> </type> <desc> - <p>This function is used to open a TPKT connection.</p> - <p>The <c><![CDATA[module]]></c> option makes it possible for the user to provide - their own callback module. The <c><![CDATA[receive_message/4]]></c> or - <c><![CDATA[process_received_message/4]]></c> functions of this module is called - when a new message is received (which one depends on the size of the - message; small - receive_message, large - process_received_message). - Default value is <em>megaco</em>.</p> + <p>This function is used to open a TPKT connection.</p> + <taglist> + <tag><c><![CDATA[module]]></c></tag> + <item> + <p>This option makes it possible for the user to provide + their own callback module. + The <c><![CDATA[receive_message/4]]></c> + or <c><![CDATA[process_received_message/4]]></c> functions of + this module is called when a new message is received. + Which one is called depends on the size of the message; </p> + <taglist> + <tag><c><![CDATA[small]]></c></tag> + <item><p>receive_message</p></item> + <tag><c><![CDATA[large]]></c></tag> + <item><p>process_received_message</p></item> + </taglist> + <p>Default value is <em>megaco</em>. </p> + </item> + </taglist> </desc> </func> <func> diff --git a/lib/megaco/doc/src/megaco_udp.xml b/lib/megaco/doc/src/megaco_udp.xml index 3add131fa8..f9dc551f6c 100644 --- a/lib/megaco/doc/src/megaco_udp.xml +++ b/lib/megaco/doc/src/megaco_udp.xml @@ -56,7 +56,11 @@ <type> <v>TransportRef = pid() | regname()</v> <v>OptionList = [option()]</v> - <v>option() = {port, integer()} | {options, list()} | {receive_handle, receive_handle()} | {module, atom()} | {inet_backend, default | inet | socket}</v> + <v>option() = {port, integer()} | + {options, list()} | + {receive_handle, receive_handle()} | + {module, atom()} | + {inet_backend, default | inet | socket}</v> <v>Handle = socket_handle()</v> <v>receive_handle() = term()</v> <v>ControlPid = pid()</v> @@ -64,19 +68,24 @@ </type> <desc> <p>This function is used to open an UDP/IP socket.</p> - <p>The <c><![CDATA[module]]></c> option makes it possible for the user - to provide their own callback module. - The functions <c><![CDATA[receive_message/4]]></c> or - <c><![CDATA[process_received_message/4]]></c> of this module is called - when a new message is received (which one depends on the size of the - message: </p> <taglist> - <tag><c><![CDATA[small]]></c></tag> - <item><p>receive_message</p></item> - <tag><c><![CDATA[large]]></c></tag> - <item><p>process_received_message)</p></item> + <tag><c><![CDATA[module]]></c></tag> + <item> + <p>The option makes it possible for the user to provide + their own callback module. + The functions <c><![CDATA[receive_message/4]]></c> or + <c><![CDATA[process_received_message/4]]></c> + of this module is called when a new message is received. + Which one depends on the size of the message: </p> + <taglist> + <tag><c><![CDATA[small]]></c></tag> + <item><p>receive_message</p></item> + <tag><c><![CDATA[large]]></c></tag> + <item><p>process_received_message</p></item> + </taglist> + <p>Default value is <em>megaco</em>.</p> + </item> </taglist> - <p>Default value is (the module) <em>megaco</em>.</p> </desc> </func> <func> |