inets: Align with alphabetical order and clean local anchor handling

Functions in the same module can be referenced as #Function-Arity, no
need to make special markers for them.

1 files changed, 143 insertions, 157 deletions

diff --git a/lib/inets/doc/src/tftp.xml b/lib/inets/doc/src/tftp.xml
index 78f77f5b91..00d9d53376 100644
--- a/lib/inets/doc/src/tftp.xml
+++ b/lib/inets/doc/src/tftp.xml
@@ -221,88 +221,57 @@
   </section>
 
   <funcs>
+    <marker id="change_config_daemons"></marker>
     <func>
-      <name>start(Options) -> {ok, Pid} | {error, Reason}</name>
-      <fsummary>Starts a daemon process.</fsummary>
+      <name>change_config(daemons, Options) -> [{Pid, Result}]</name>
+      <fsummary>Changes configuration for all daemons.
+      </fsummary>
       <type>
         <v>Options = [option()]</v>
         <v>Pid = pid()</v>
+        <v>Result = ok | {error, Reason}</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Starts a daemon process listening for UDP packets on a
-	port. When it receives a request for read or write, it spawns
-	a temporary server process handling the actual transfer
-	of the (virtual) file.</p>
+        <p>Changes configuration for all TFTP daemon processes. </p>
 	
-	<marker id="read_file"></marker>
+	<marker id="change_config_servers"></marker>
       </desc>
     </func>
 
     <func>
-      <name>read_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason}</name>
-      <fsummary>Reads a (virtual) file from a TFTP server.</fsummary>
+      <name>change_config(servers, Options) -> [{Pid, Result}]</name>
+      <fsummary>Changes configuration for all servers.
+      </fsummary>
       <type>
-        <v>RemoteFilename = string()</v>
-        <v>LocalFilename = binary | string()</v>
         <v>Options = [option()]</v>
-        <v>LastCallbackState = term()</v>
+        <v>Pid = pid()</v>
+        <v>Result = ok | {error, Reason}</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Reads a (virtual) file <c>RemoteFilename</c> from a TFTP
-	server.</p>
-	<p>If <c>LocalFilename</c> is the atom <c>binary</c>,
-	<c>tftp_binary</c> is used as callback module. It concatenates
-	all transferred blocks and returns them as one single binary
-	in <c>LastCallbackState</c>.</p>
-	<p>If <c>LocalFilename</c> is a string and there are no
-	registered callback modules, <c>tftp_file</c> is used as
-	callback module. It writes each transferred block to the file
-	named <c>LocalFilename</c> and returns the number of
-	transferred bytes in <c>LastCallbackState</c>.</p>
-	<p>If <c>LocalFilename</c> is a string and there are registered
-	callback modules, <c>LocalFilename</c> is tested against
-	the regexps of these and the callback module corresponding to
-	the first match is used, or an error tuple is returned if no
-	matching regexp is found.</p>
-      </desc>
+        <p>Changes configuration for all TFTP server processes.</p>
 	
-      <marker id="write_file"></marker>
+	<marker id="change_config_pid"></marker>
+      </desc>
     </func>
 
     <func>
-      <name>write_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason}</name>
-      <fsummary>Writes a (virtual) file to a TFTP server.</fsummary>
+      <name>change_config(Pid, Options) -> Result</name>
+      <fsummary>Changes configuration for a TFTP daemon, server, 
+      or client process.</fsummary>
       <type>
-        <v>RemoteFilename = string()</v>
-        <v>LocalFilename = binary() | string()</v>
+        <v>Pid = pid()</v>
         <v>Options = [option()]</v>
-        <v>LastCallbackState = term()</v>
+        <v>Result = ok | {error, Reason}</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Writes a (virtual) file <c>RemoteFilename</c> to a TFTP
-          server.</p>
-        <p>If <c>LocalFilename</c> is a binary, <c>tftp_binary</c> is
-          used as callback module. The binary is transferred block by
-          block and the number of transferred bytes is returned in
-          <c>LastCallbackState</c>.</p>
-        <p>If <c>LocalFilename</c> is a string and there are no
-          registered callback modules, <c>tftp_file</c> is used as
-          callback module. It reads the file named <c>LocalFilename</c>
-          block by block and returns the number of transferred bytes
-          in <c>LastCallbackState</c>.</p>
-        <p>If <c>LocalFilename</c> is a string and there are registered
-	callback modules, <c>LocalFilename</c> is tested against
-	the regexps of these and the callback module corresponding to
-	the first match is used, or an error tuple is returned if no
-	matching regexp is found.</p>
-	
+        <p>Changes configuration for a TFTP daemon, server, or client process.</p>
 	<marker id="info_daemons"></marker>
       </desc>
     </func>
-
+    
     <func>
       <name>info(daemons) -> [{Pid, Options}]</name>
       <fsummary>Returns information about all daemons.</fsummary>
@@ -342,72 +311,89 @@
       </type>
       <desc>
         <p>Returns information about a TFTP daemon, server, or client process.</p>
-	
-	<marker id="change_config_daemons"></marker>
       </desc>
     </func>
-
-   <func>
-      <name>change_config(daemons, Options) -> [{Pid, Result}]</name>
-      <fsummary>Changes configuration for all daemons.
-      </fsummary>
+       
+    <func>
+      <name>read_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason}</name>
+      <fsummary>Reads a (virtual) file from a TFTP server.</fsummary>
       <type>
+        <v>RemoteFilename = string()</v>
+        <v>LocalFilename = binary | string()</v>
         <v>Options = [option()]</v>
-        <v>Pid = pid()</v>
-        <v>Result = ok | {error, Reason}</v>
+        <v>LastCallbackState = term()</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Changes configuration for all TFTP daemon processes. </p>
-	
-	<marker id="change_config_servers"></marker>
+        <p>Reads a (virtual) file <c>RemoteFilename</c> from a TFTP
+	server.</p>
+	<p>If <c>LocalFilename</c> is the atom <c>binary</c>,
+	<c>tftp_binary</c> is used as callback module. It concatenates
+	all transferred blocks and returns them as one single binary
+	in <c>LastCallbackState</c>.</p>
+	<p>If <c>LocalFilename</c> is a string and there are no
+	registered callback modules, <c>tftp_file</c> is used as
+	callback module. It writes each transferred block to the file
+	named <c>LocalFilename</c> and returns the number of
+	transferred bytes in <c>LastCallbackState</c>.</p>
+	<p>If <c>LocalFilename</c> is a string and there are registered
+	callback modules, <c>LocalFilename</c> is tested against
+	the regexps of these and the callback module corresponding to
+	the first match is used, or an error tuple is returned if no
+	matching regexp is found.</p>
       </desc>
+	
+      <marker id="write_file"></marker>
     </func>
-
+    
     <func>
-      <name>change_config(servers, Options) -> [{Pid, Result}]</name>
-      <fsummary>Changes configuration for all servers.
-      </fsummary>
+       <name>start(Options) -> {ok, Pid} | {error, Reason}</name>
+      <fsummary>Starts a daemon process.</fsummary>
       <type>
         <v>Options = [option()]</v>
         <v>Pid = pid()</v>
-        <v>Result = ok | {error, Reason}</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Changes configuration for all TFTP server processes.</p>
+        <p>Starts a daemon process listening for UDP packets on a
+	port. When it receives a request for read or write, it spawns
+	a temporary server process handling the actual transfer
+	of the (virtual) file.</p>
 	
-	<marker id="change_config_pid"></marker>
+	<marker id="read_file"></marker>
       </desc>
     </func>
 
     <func>
-      <name>change_config(Pid, Options) -> Result</name>
-      <fsummary>Changes configuration for a TFTP daemon, server, 
-      or client process.</fsummary>
+      <name>write_file(RemoteFilename, LocalFilename, Options) -> {ok, LastCallbackState} | {error, Reason}</name>
+      <fsummary>Writes a (virtual) file to a TFTP server.</fsummary>
       <type>
-        <v>Pid = pid()</v>
+        <v>RemoteFilename = string()</v>
+        <v>LocalFilename = binary() | string()</v>
         <v>Options = [option()]</v>
-        <v>Result = ok | {error, Reason}</v>
-        <v>Reason = term()</v>
-      </type>
-      <desc>
-        <p>Changes configuration for a TFTP daemon, server, or client process.</p>
-	
-	<marker id="start2"></marker>
-      </desc>
-    </func>
-
-    <func>
-      <name>start() -> ok | {error, Reason}</name>
-      <fsummary>Starts the <c>Inets</c> application.</fsummary>
-      <type>
+        <v>LastCallbackState = term()</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Starts the <c>Inets</c> application.</p>
+        <p>Writes a (virtual) file <c>RemoteFilename</c> to a TFTP
+          server.</p>
+        <p>If <c>LocalFilename</c> is a binary, <c>tftp_binary</c> is
+          used as callback module. The binary is transferred block by
+          block and the number of transferred bytes is returned in
+          <c>LastCallbackState</c>.</p>
+        <p>If <c>LocalFilename</c> is a string and there are no
+          registered callback modules, <c>tftp_file</c> is used as
+          callback module. It reads the file named <c>LocalFilename</c>
+          block by block and returns the number of transferred bytes
+          in <c>LastCallbackState</c>.</p>
+        <p>If <c>LocalFilename</c> is a string and there are registered
+	callback modules, <c>LocalFilename</c> is tested against
+	the regexps of these and the callback module corresponding to
+	the first match is used, or an error tuple is returned if no
+	matching regexp is found.</p>
       </desc>
     </func>
+   
   </funcs>
 
   <section>
@@ -467,43 +453,32 @@
   </section>
 
   <funcs>
-    <func>
-      <name>prepare(Peer, Access, Filename, Mode, SuggestedOptions, InitialState) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}}</name>
-      <fsummary>Prepares to open a file on the client side.</fsummary>
+     <func>
+      <name>Module:abort(Code, Text, State) -> ok</name>
+      <fsummary>Aborts the file transfer.</fsummary>
       <type>
-        <v>Peer = {PeerType, PeerHost, PeerPort}</v>
-        <v>PeerType = inet | inet6</v>
-        <v>PeerHost = ip_address()</v>
-        <v>PeerPort = integer()</v>
-        <v>Access = read | write</v>
-        <v>Filename = string()</v>
-        <v>Mode = string()</v>
-        <v>SuggestedOptions = AcceptedOptions = [{Key, Value}]</v>
-        <v>&nbsp;Key = Value = string()</v>
-        <v>InitialState = [] | [{root_dir, string()}]</v>
-        <v>NewState = term()</v>
         <v>Code = undef | enoent | eacces | enospc</v>
         <v>&nbsp;&nbsp;| badop | eexist | baduser | badopt</v>
         <v>&nbsp;&nbsp;| int()</v>
         <v>Text = string()</v>
+        <v>State = term()</v>
       </type>
       <desc>
-	<p>Prepares to open a file on the client side.</p>
-	<p>No new options can be added, but those present in
-	<c>SuggestedOptions</c> can be omitted or replaced with new
-	values in <c>AcceptedOptions</c>.</p>
-	<p>This is followed by a call to <c>open/4</c> before any
-	read/write access is performed. <c>AcceptedOptions</c> is
-	sent to the server, which replies with the options that it
-	accepts. These are then forwarded to <c>open/4</c> as
-	<c>SuggestedOptions</c>.</p>
-    
-	<marker id="open"></marker>
+        <p>Invoked when the file transfer is aborted.</p>
+        <p>The callback function is expected to clean
+	up its used resources after the aborted file
+	transfer, such as closing open file
+	descriptors and so on. The function is not
+	invoked if any of the other callback
+	functions returns an error, as it is
+	expected that they already have cleaned up
+	the necessary resources. However, it is
+	invoked if the functions fail (crash).</p>
       </desc>
     </func>
-
-    <func>
-      <name>open(Peer, Access, Filename, Mode, SuggestedOptions, State) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}}</name>
+    
+      <func>
+      <name>Module:open(Peer, Access, Filename, Mode, SuggestedOptions, State) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}}</name>
       <fsummary>Opens a file for read or write access.</fsummary>
       <type>
         <v>Peer = {PeerType, PeerHost, PeerPort}</v>
@@ -536,9 +511,44 @@
 	<marker id="read"></marker>
       </desc>
     </func>
+    
+    <func>
+      <name>Module:prepare(Peer, Access, Filename, Mode, SuggestedOptions, InitialState) -> {ok, AcceptedOptions, NewState} | {error, {Code, Text}}</name>
+      <fsummary>Prepares to open a file on the client side.</fsummary>
+      <type>
+        <v>Peer = {PeerType, PeerHost, PeerPort}</v>
+        <v>PeerType = inet | inet6</v>
+        <v>PeerHost = ip_address()</v>
+        <v>PeerPort = integer()</v>
+        <v>Access = read | write</v>
+        <v>Filename = string()</v>
+        <v>Mode = string()</v>
+        <v>SuggestedOptions = AcceptedOptions = [{Key, Value}]</v>
+        <v>&nbsp;Key = Value = string()</v>
+        <v>InitialState = [] | [{root_dir, string()}]</v>
+        <v>NewState = term()</v>
+        <v>Code = undef | enoent | eacces | enospc</v>
+        <v>&nbsp;&nbsp;| badop | eexist | baduser | badopt</v>
+        <v>&nbsp;&nbsp;| int()</v>
+        <v>Text = string()</v>
+      </type>
+      <desc>
+	<p>Prepares to open a file on the client side.</p>
+	<p>No new options can be added, but those present in
+	<c>SuggestedOptions</c> can be omitted or replaced with new
+	values in <c>AcceptedOptions</c>.</p>
+	<p>This is followed by a call to <c>open/4</c> before any
+	read/write access is performed. <c>AcceptedOptions</c> is
+	sent to the server, which replies with the options that it
+	accepts. These are then forwarded to <c>open/4</c> as
+	<c>SuggestedOptions</c>.</p>
+    
+	<marker id="open"></marker>
+      </desc>
+    </func>
 
     <func>
-      <name>read(State) -> {more, Bin, NewState} | {last, Bin, FileSize} | {error, {Code, Text}}</name>
+      <name>Module:read(State) -> {more, Bin, NewState} | {last, Bin, FileSize} | {error, {Code, Text}}</name>
       <fsummary>Reads a chunk from the file.</fsummary>
       <type>
         <v>State = NewState = term()</v>
@@ -565,7 +575,7 @@
     </func>
 
     <func>
-      <name>write(Bin, State) -> {more, NewState} | {last, FileSize} | {error, {Code, Text}}</name>
+      <name>Module:write(Bin, State) -> {more, NewState} | {last, FileSize} | {error, {Code, Text}}</name>
       <fsummary>Writes a chunk to the file.</fsummary>
       <type>
         <v>Bin = binary()</v>
@@ -590,30 +600,6 @@
 	<marker id="abort"></marker>
       </desc>
     </func>
-
-    <func>
-      <name>abort(Code, Text, State) -> ok</name>
-      <fsummary>Aborts the file transfer.</fsummary>
-      <type>
-        <v>Code = undef | enoent | eacces | enospc</v>
-        <v>&nbsp;&nbsp;| badop | eexist | baduser | badopt</v>
-        <v>&nbsp;&nbsp;| int()</v>
-        <v>Text = string()</v>
-        <v>State = term()</v>
-      </type>
-      <desc>
-        <p>Invoked when the file transfer is aborted.</p>
-        <p>The callback function is expected to clean
-	up its used resources after the aborted file
-	transfer, such as closing open file
-	descriptors and so on. The function is not
-	invoked if any of the other callback
-	functions returns an error, as it is
-	expected that they already have cleaned up
-	the necessary resources. However, it is
-	invoked if the functions fail (crash).</p>
-      </desc>
-    </func>
   </funcs>
   
   <section>
@@ -628,7 +614,7 @@
 
   <funcs>
     <func>
-      <name>error_msg(Format, Data) -> ok | exit(Reason)</name>
+      <name>Logger:error_msg(Format, Data) -> ok | exit(Reason)</name>
       <fsummary>Logs an error message.</fsummary>
       <type>
         <v>Format = string()</v>
@@ -644,32 +630,32 @@
     </func>
 
     <func>
-      <name>warning_msg(Format, Data) -> ok | exit(Reason)</name>
-      <fsummary>Logs a warning message.</fsummary>
+      <name>Logger:info_msg(Format, Data) -> ok | exit(Reason)</name>
+      <fsummary>Logs an info message.</fsummary>
       <type>
         <v>Format = string()</v>
         <v>Data = [term()]</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Logs a warning message. 
-	See <c>error_logger:warning_msg/2</c> for details.</p>
-	
-	<marker id="info_msg"></marker>
+        <p>Logs an info message. 
+	See <c>error_logger:info_msg/2</c>  for details.</p>
       </desc>
     </func>
-
+    
     <func>
-      <name>info_msg(Format, Data) -> ok | exit(Reason)</name>
-      <fsummary>Logs an info message.</fsummary>
+      <name>Logger:warning_msg(Format, Data) -> ok | exit(Reason)</name>
+      <fsummary>Logs a warning message.</fsummary>
       <type>
         <v>Format = string()</v>
         <v>Data = [term()]</v>
         <v>Reason = term()</v>
       </type>
       <desc>
-        <p>Logs an info message. 
-	See <c>error_logger:info_msg/2</c>  for details.</p>
+        <p>Logs a warning message. 
+	See <c>error_logger:warning_msg/2</c> for details.</p>
+	
+	<marker id="info_msg"></marker>
       </desc>
     </func>
   </funcs>