File 1512-megaco-doc-Improved-documentation-for-udp-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1512-megaco-doc-Improved-documentation-for-udp-open-and-t.patch of Package erlang (Revision c37f636f556d133a129c9e9a7093d763)

Currently displaying revision c37f636f556d133a129c9e9a7093d763 , Show latest

From 5191ecfece28a6577d42b4ee0ee6c2c7bba8114c Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Thu, 5 Aug 2021 16:23:55 +0200
Subject: [PATCH 12/13] [megaco|doc] Improved documentation for (udp) open and
 (tcp) connect

Improved documentation for the megaco_udp:open and megaco_tcp:connect
functions.

OTP-17533
---
 lib/megaco/doc/src/megaco_tcp.xml | 33 +++++++++++++++++++++++--------
 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>
- This function is used to open a TPKT connection.
- 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 megaco.
+	This function is used to open a TPKT connection.
+	<taglist>
+	 <tag><c><![CDATA[module]]></c></tag>
+	 <item>
+	 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; 
+	 <taglist>
+	 <tag><c><![CDATA[small]]></c></tag>
+	 <item>receive_message</item>
+	 <tag><c><![CDATA[large]]></c></tag>
+	 <item>process_received_message</item>
+	 </taglist>
+	 Default value is megaco. 
+	 </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>
 	This function is used to open an UDP/IP socket.
-	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: 
 	<taglist>
-	 <tag><c><![CDATA[small]]></c></tag>
-	 <item>receive_message</item>
-	 <tag><c><![CDATA[large]]></c></tag>
-	 <item>process_received_message)</item>
+	 <tag><c><![CDATA[module]]></c></tag>
+	 <item>
+	 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: 
+	 <taglist>
+	 <tag><c><![CDATA[small]]></c></tag>
+	 <item>receive_message</item>
+	 <tag><c><![CDATA[large]]></c></tag>
+	 <item>process_received_message</item>
+	 </taglist>
+	 Default value is megaco.
+	 </item>
 	</taglist>
-	Default value is (the module) megaco.
 </desc>
 </func>
 <func>
-- 
2.31.1

Places

File 1512-megaco-doc-Improved-documentation-for-udp-open-and-t.patch of Package erlang (Revision c37f636f556d133a129c9e9a7093d763)

Places