Merge pull request #7743 from garazdawi/lukas/docs/add-module-prefix

Add Module: prefix to all callback functions
erlang · Oct 13, 2023 · 42596d6 · 42596d6
2 parents c0b1363 + 486b18a
commit 42596d6
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 70 deletions.
diff --git a/lib/inets/doc/src/httpd_custom_api.xml b/lib/inets/doc/src/httpd_custom_api.xml
@@ -34,7 +34,7 @@
   </description>  
   <funcs>
      <func>
-      <name since="OTP 18.1.1">response_default_headers() -> [Header] </name>
+      <name since="OTP 18.1.1">Module:response_default_headers() -> [Header] </name>
       <fsummary>Provide default headers for the HTTP servers responses.</fsummary>
       <type>
         <v>Header = {HeaderName :: string(), HeaderValue::string()}</v>
@@ -48,7 +48,7 @@
     </func>
 
     <func>
-      <name since="OTP 17.5.6">response_header({HeaderName, HeaderValue}) ->  {true, Header} | false </name>
+      <name since="OTP 17.5.6">Module:response_header({HeaderName, HeaderValue}) ->  {true, Header} | false </name>
       <fsummary>Filter and possible alter HTTP response headers.</fsummary>
       <type>
         <v>Header = {HeaderName :: string(), HeaderValue::string()}</v>
@@ -61,7 +61,7 @@
     </func>
 
     <func>
-      <name since="OTP 17.5.6">request_header({HeaderName, HeaderValue}) ->   {true, Header} | false </name>
+      <name since="OTP 17.5.6">Module:request_header({HeaderName, HeaderValue}) ->   {true, Header} | false </name>
       <fsummary>Filter and possible alter HTTP request headers.</fsummary>
       <type>
 	<v>Header = {HeaderName :: string(), HeaderValue::string()}</v>

diff --git a/lib/megaco/doc/src/megaco_user.xml b/lib/megaco/doc/src/megaco_user.xml
@@ -164,8 +164,8 @@ protocol_version() = integer()    ]]></code>
 
   <funcs>
     <func>
-      <name since="">handle_connect(ConnHandle, ProtocolVersion) -> ok | error | {error,ErrorDescr}</name>
-      <name since="">handle_connect(ConnHandle, ProtocolVersion, Extra) -> ok | error | {error,ErrorDescr}</name>
+      <name since="">Module:handle_connect(ConnHandle, ProtocolVersion) -> ok | error | {error,ErrorDescr}</name>
+      <name since="">Module:handle_connect(ConnHandle, ProtocolVersion, Extra) -> ok | error | {error,ErrorDescr}</name>
       <fsummary>Invoked when a new connection is established</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -202,7 +202,7 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_disconnect(ConnHandle, ProtocolVersion, Reason) -> ok</name>
+      <name since="">Module:handle_disconnect(ConnHandle, ProtocolVersion, Reason) -> ok</name>
       <fsummary>Invoked when a connection is teared down</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -220,8 +220,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED) -> reply | {reply, ED} | no_reply | {no_reply, ED} </name>
-      <name since="">handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED, Extra) -> reply | {reply, ED} | no_reply | {no_reply, ED} </name>
+      <name since="">Module:handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED) -> reply | {reply, ED} | no_reply | {no_reply, ED} </name>
+      <name since="">Module:handle_syntax_error(ReceiveHandle, ProtocolVersion, DefaultED, Extra) -> reply | {reply, ED} | no_reply | {no_reply, ED} </name>
       <fsummary>Invoked when a received message had syntax errors</fsummary>
       <type>
         <v>ReceiveHandle    = receive_handle()</v>
@@ -258,8 +258,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr) -> ok</name>
-      <name since="">handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr, Extra) -> ok</name>
+      <name since="">Module:handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr) -> ok</name>
+      <name since="">Module:handle_message_error(ConnHandle, ProtocolVersion, ErrorDescr, Extra) -> ok</name>
       <fsummary>Invoked when a received message just contains an error</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -316,8 +316,8 @@ protocol_version() = integer()    ]]></code>
 -->
 
     <func>
-      <name since="">handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request</name>
-      <name since="">handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request</name>
+      <name since="">Module:handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests) -> pending() | reply() | ignore_trans_request</name>
+      <name since="">Module:handle_trans_request(ConnHandle, ProtocolVersion, ActionRequests, Extra) -> pending() | reply() | ignore_trans_request</name>
       <fsummary>Invoked for each transaction request</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -420,8 +420,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply()</name>
-      <name since="">handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply()</name>
+      <name since="">Module:handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData) -> reply()</name>
+      <name since="">Module:handle_trans_long_request(ConnHandle, ProtocolVersion, ReqData, Extra) -> reply()</name>
       <fsummary>Optionally invoked for a time consuming transaction request</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -460,8 +460,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok</name>
-      <name since="">handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok</name>
+      <name since="">Module:handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData) -> ok</name>
+      <name since="">Module:handle_trans_reply(ConnHandle, ProtocolVersion, UserReply, ReplyData, Extra) -> ok</name>
       <fsummary>Optionally invoked for a transaction reply</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -593,8 +593,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok</name>
-      <name since="">handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok</name>
+      <name since="">Module:handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData) -> ok</name>
+      <name since="">Module:handle_trans_ack(ConnHandle, ProtocolVersion, AckStatus, AckData, Extra) -> ok</name>
       <fsummary>Optionally invoked for a transaction acknowledgement</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -658,8 +658,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok</name>
-      <name since="">handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok</name>
+      <name since="">Module:handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans) -> ok</name>
+      <name since="">Module:handle_unexpected_trans(ConnHandle, ProtocolVersion, Trans, Extra) -> ok</name>
       <fsummary>Invoked when an unexpected message is received</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -685,8 +685,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok</name>
-      <name since="">handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok</name>
+      <name since="">Module:handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid) -> ok</name>
+      <name since="">Module:handle_trans_request_abort(ConnHandle, ProtocolVersion, TransNo, Pid, Extra) -> ok</name>
       <fsummary>Invoked when an transaction request has been aborted</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>
@@ -710,8 +710,8 @@ protocol_version() = integer()    ]]></code>
     </func>
 
     <func>
-      <name since="">handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok</name>
-      <name since="">handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok</name>
+      <name since="">Module:handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl) -> ok</name>
+      <name since="">Module:handle_segment_reply(ConnHandle, ProtocolVersion, TransNo, SegNo, SegCompl, Extra) -> ok</name>
       <fsummary>Segment Reply Indication</fsummary>
       <type>
         <v>ConnHandle      = conn_handle()</v>

diff --git a/lib/snmp/doc/src/snmpa_discovery_handler.xml b/lib/snmp/doc/src/snmpa_discovery_handler.xml
@@ -51,7 +51,7 @@
 
   <funcs>
     <func>
-      <name since="">stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo}</name>
+      <name since="">Module:stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore | {ok, usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewExtraInfo}</name>
       <fsummary>Discovery stage 1 finish</fsummary>
       <type>
         <v>TargetName = string()</v>

diff --git a/lib/snmp/doc/src/snmpa_error_report.xml b/lib/snmp/doc/src/snmpa_error_report.xml
@@ -52,7 +52,7 @@
   </description>
   <funcs>
     <func>
-      <name since="">config_err(Format, Args) -> void()</name>
+      <name since="">Module:config_err(Format, Args) -> void()</name>
       <fsummary>Called if a configuration error occurs</fsummary>
       <type>
         <v>Format = string()</v>
@@ -68,7 +68,7 @@
       </desc>
     </func>
     <func>
-      <name since="">user_err(Format, Args) -> void()</name>
+      <name since="">Module:user_err(Format, Args) -> void()</name>
       <fsummary>Called if a user related error occurs</fsummary>
       <type>
         <v>Format = string()</v>

diff --git a/lib/snmp/doc/src/snmpa_network_interface.xml b/lib/snmp/doc/src/snmpa_network_interface.xml
@@ -68,7 +68,7 @@
 
   <funcs>
     <func>
-      <name since="">start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason}</name>
+      <name since="">Module:start_link(Prio, NoteStore, MasterAgent, Opts) -> {ok, Pid} | {error, Reason}</name>
       <fsummary>Start-link the network interface process</fsummary>
       <type>
         <v>Prio        = priority()</v>
@@ -93,7 +93,7 @@
     </func>
 
     <func>
-      <name since="">info(Pid) -> [{Key, Value}]</name>
+      <name since="">Module:info(Pid) -> [{Key, Value}]</name>
       <fsummary>Return information about the running network interface process</fsummary>
       <type>
         <v>Pid = pid()</v>
@@ -112,7 +112,7 @@
     </func>
 
     <func>
-      <name since="">verbosity(Pid, Verbosity) -> void()</name>
+      <name since="">Module:verbosity(Pid, Verbosity) -> void()</name>
       <fsummary>Change the verbosity of a running network interface process</fsummary>
       <type>
         <v>Pid       = pid()</v>
@@ -126,7 +126,7 @@
     </func>
 
     <func>
-      <name since="">get_log_type(Pid) -> {ok, LogType} | {error, Reason}</name>
+      <name since="">Module:get_log_type(Pid) -> {ok, LogType} | {error, Reason}</name>
       <fsummary>Get the Audit Trail Log type</fsummary>
       <type>
         <v>Pid     = pid()</v>
@@ -147,7 +147,7 @@
     </func>
 
     <func>
-      <name since="">set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason}</name>
+      <name since="">Module:set_log_type(Pid, NewType) -> {ok, OldType} | {error, Reason}</name>
       <fsummary>Change the Audit Trail Log type</fsummary>
       <type>
         <v>Pid     = pid()</v>

diff --git a/lib/snmp/doc/src/snmpa_network_interface_filter.xml b/lib/snmp/doc/src/snmpa_network_interface_filter.xml
@@ -101,7 +101,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' |
   </section>
   <funcs>
     <func>
-      <name since="">accept_recv(Domain, Addr) -> boolean()</name>
+      <name since="">Module:accept_recv(Domain, Addr) -> boolean()</name>
       <fsummary>Shall the received message be accepted</fsummary>
       <type>
 	<v>Domain = transportDomain()</v>
@@ -116,7 +116,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' |
       </desc>
     </func>
     <func>
-      <name since="">accept_send(Domain, Addr) -> boolean()</name>
+      <name since="">Module:accept_send(Domain, Addr) -> boolean()</name>
       <fsummary>Shall the message be sent</fsummary>
       <type>
 	<v>Domain = transportDomain()</v>
@@ -131,7 +131,7 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' |
       </desc>
     </func>
     <func>
-      <name since="">accept_recv_pdu(Domain, Addr, PduType) -> boolean()</name>
+      <name since="">Module:accept_recv_pdu(Domain, Addr, PduType) -> boolean()</name>
       <fsummary>Shall the received pdu be accepted</fsummary>
       <type>
 	<v>Domain = transportDomain()</v>
@@ -148,15 +148,14 @@ pdu_type() = 'get-request' | 'get-next-request' | 'get-response' |
       </desc>
     </func>
     <func>
-      <name since="">accept_send_pdu(Targets, PduType) -> Reply</name>
+      <name since="">Module:accept_send_pdu(Targets, PduType) -> Reply</name>
       <fsummary>Shall the pdu be sent</fsummary>
       <type>
-        <v>Targets = targets()</v>
-        <v>targets() = [target()]</v>
-        <v>target() = {Domain, Addr}</v>
+        <v>Targets = [Target]</v>
+        <v>Target = {Domain, Addr}</v>
 	<v>Domain = transportDomain()</v>
 	<v>Addr = transportAddressWithPort()</v>
-        <v>PduType = pdu_type() > 0</v>
+        <v>PduType = pdu_type()</v>
         <v>Reply = boolean() | NewTargets</v>
         <v>NewTargets = targets()</v>
       </type>

diff --git a/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml b/lib/snmp/doc/src/snmpa_notification_delivery_info_receiver.xml
@@ -46,10 +46,10 @@
       must export the following functions: </p>
     <list type="bulleted">
       <item>
-        <p><seemfa marker="#delivery_targets/3">delivery_targets/3</seemfa></p>
+        <p><seemfa marker="#Module:delivery_targets/3">delivery_targets/3</seemfa></p>
       </item>
       <item>
-        <p><seemfa marker="#delivery_info/4">delivery_info/4</seemfa></p>
+        <p><seemfa marker="#Module:delivery_info/4">delivery_info/4</seemfa></p>
       </item>
     </list>
     <p>The semantics of them and their exact signatures are explained
@@ -76,12 +76,12 @@
 
   <funcs>
     <func>
-      <name since="">delivery_targets(Tag, Targets, Extra) -> void()</name>
+      <name since="">Module:delivery_targets(Tag, Targets, Extra) -> void()</name>
       <fsummary>Inform about target addresses</fsummary>
       <type>
         <v>Tag = term()</v>
         <v>Targets = [Target]</v>
-        <v>Target = {transportDomain(), transportAddressWithPort()</v>
+        <v>Target = {transportDomain(), transportAddressWithPort()}</v>
         <v>Extra = term()</v>
       </type>
       <desc>
@@ -97,14 +97,13 @@
     </func>
 
     <func>
-      <name since="">delivery_info(Tag, Target, DeliveryResult, Extra) -> void()</name>
+      <name since="">Module:delivery_info(Tag, Target, DeliveryResult, Extra) -> void()</name>
       <fsummary>Inform about delivery result</fsummary>
       <type>
         <v>Tag = term()</v>
         <v>Targets = [Target]</v>
-        <v>Target = {transportDomain(), transportAddressWithPort()</v>
-        <v>DeliveryResult = delivery_result()</v>
-        <v>delivery_result() = no_response | got_response</v>
+        <v>Target = {transportDomain(), transportAddressWithPort()}</v>
+        <v>DeliveryResult = no_response | got_response</v>
         <v>Extra = term()</v>
       </type>
       <desc>

diff --git a/lib/snmp/doc/src/snmpa_notification_filter.xml b/lib/snmp/doc/src/snmpa_notification_filter.xml
@@ -51,7 +51,7 @@
   </description>
   <funcs>
     <func>
-      <name since="">handle_notification(Notif, Data) -> Reply</name>
+      <name since="">Module:handle_notification(Notif, Data) -> Reply</name>
       <fsummary>Handle a notification</fsummary>
       <type>
         <v>Reply = send | {send, NewNotif} | dont_send</v>