Inets Reference Manual

Editorial changes

1 files changed, 58 insertions, 48 deletions

diff --git a/lib/inets/doc/src/mod_security.xml b/lib/inets/doc/src/mod_security.xml
index 467c68d364..7aae98e1cf 100644
--- a/lib/inets/doc/src/mod_security.xml
+++ b/lib/inets/doc/src/mod_security.xml
@@ -40,19 +40,21 @@
       <name>list_auth_users(Address, Port) -> Users | []</name>
       <name>list_auth_users(Port, Dir) -> Users | []</name>
       <name>list_auth_users(Address, Port, Dir) -> Users | []</name>
-      <fsummary>List users that have authenticated within the SecurityAuthTimeout time for a given address (if specified), port number and directory  (if specified).</fsummary>
+      <fsummary>Lists users that have authenticated within the <c>SecurityAuthTimeout</c> 
+      time for a given address (if specified), port number, and directory 
+      (if specified).</fsummary>
       <type>
-        <v>Port    = integer()</v>
+        <v>Port = integer()</v>
         <v>Address = {A,B,C,D} | string() | undefined</v>
-        <v>Dir     = string()</v>
-        <v>Users   = list() = [string()]</v>
+        <v>Dir = string()</v>
+        <v>Users = list() = [string()]</v>
       </type>
       <desc>
         <marker id="list_auth_users"></marker>
-        <p><c>list_auth_users/1</c>, <c>list_auth_users/2</c> and 
-          <c>list_auth_users/3</c> returns a list of users that are 
+        <p><c>list_auth_users/1</c>, <c>list_auth_users/2</c>, and 
+          <c>list_auth_users/3</c> each returns a list of users that are 
           currently authenticated. Authentications are stored for
-          SecurityAuthTimeout seconds, and are then discarded.</p>
+          <c>SecurityAuthTimeout</c> seconds, and then discarded.</p>
       </desc>
     </func>
     <func>
@@ -60,69 +62,70 @@
       <name>list_blocked_users(Address, Port) -> Users | []</name>
       <name>list_blocked_users(Port, Dir) -> Users | []</name>
       <name>list_blocked_users(Address, Port, Dir) -> Users | []</name>
-      <fsummary>List users that are currently blocked from access to a  specified port number, for a given address (if specified).</fsummary>
+      <fsummary>Lists users that are currently blocked from access to a 
+      specified port number, for a given address (if specified).</fsummary>
       <type>
-        <v>Port    = integer()</v>
+        <v>Port = integer()</v>
         <v>Address = {A,B,C,D} | string() | undefined</v>
-        <v>Dir     = string()</v>
-        <v>Users   = list() = [string()]</v>
+        <v>Dir = string()</v>
+        <v>Users = list() = [string()]</v>
       </type>
       <desc>
         <marker id="list_blocked_users"></marker>
-        <p><c>list_blocked_users/1</c>, <c>list_blocked_users/2</c> and 
-          <c>list_blocked_users/3</c> returns a list of users that are 
+        <p><c>list_blocked_users/1</c>, <c>list_blocked_users/2</c>, and 
+          <c>list_blocked_users/3</c> each returns a list of users that are 
           currently blocked from access.</p>
       </desc>
     </func>
     <func>
       <name>block_user(User, Port, Dir, Seconds) -> true | {error, Reason}</name>
       <name>block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason}</name>
-      <fsummary>Block user from access to a directory for a certain amount of time.</fsummary>
+      <fsummary>Blocks a user from access to a directory for a certain amount of time.</fsummary>
       <type>
-        <v>User    = string()</v>
-        <v>Port    = integer()</v>
+        <v>User = string()</v>
+        <v>Port = integer()</v>
         <v>Address = {A,B,C,D} | string() | undefined</v>
-        <v>Dir     = string()</v>
+        <v>Dir = string()</v>
         <v>Seconds = integer() | infinity</v>
-        <v>Reason  = no_such_directory</v>
+        <v>Reason = no_such_directory</v>
       </type>
       <desc>
         <marker id="block_user"></marker>
-        <p><c>block_user/4</c> and <c>block_user/5</c> blocks the user 
-          <c>User</c> from the directory <c>Dir</c> for a specified 
+        <p><c>block_user/4</c> and <c>block_user/5</c> each blocks the user 
+          <c>User</c> from directory <c>Dir</c> for a specified 
           amount of time.</p>
       </desc>
     </func>
     <func>
-      <name>unblock_user(User, Port)          -> true | {error, Reason}</name>
+      <name>unblock_user(User, Port) -> true | {error, Reason}</name>
       <name>unblock_user(User, Address, Port) -> true | {error, Reason}</name>
-      <name>unblock_user(User, Port, Dir)     -> true | {error, Reason}</name>
+      <name>unblock_user(User, Port, Dir) -> true | {error, Reason}</name>
       <name>unblock_user(User, Address, Port, Dir) -> true | {error, Reason}</name>
-      <fsummary>Remove a blocked user from the block list</fsummary>
+      <fsummary>Removes a blocked user from the block list.</fsummary>
       <type>
-        <v>User   = string()</v>
-        <v>Port   = integer()</v>
+        <v>User = string()</v>
+        <v>Port = integer()</v>
         <v>Address = {A,B,C,D} | string() | undefined</v>
-        <v>Dir    = string()</v>
+        <v>Dir = string()</v>
         <v>Reason = term()</v>
       </type>
       <desc>
         <marker id="unblock_user"></marker>
-        <p><c>unblock_user/2</c>, <c>unblock_user/3</c> and 
-          <c>unblock_user/4</c> removes the user <c>User</c> from 
-          the list of blocked users for the Port (and Dir) specified.</p>
+        <p><c>unblock_user/2</c>, <c>unblock_user/3</c>, and 
+          <c>unblock_user/4</c> each removes the user <c>User</c> from 
+          the list of blocked users for <c>Port</c> (and <c>Dir</c>).</p>
       </desc>
     </func>
   </funcs>
 
   <section>
     <marker id="callback_module"></marker>
-    <title>The SecurityCallbackModule</title>
-    <p>The SecurityCallbackModule is a user written module that can receive 
-      events from the mod_security Erlang Webserver API module. 
-      This module only exports the function(s),
+    <title>SecurityCallbackModule</title>
+    <p>The <c>SecurityCallbackModule</c> is a user-written module that can receive 
+      events from the <c>mod_security</c> Erlang web server API module. 
+      This module only exports the functions
       <seealso marker="#callback_module_event">event/4,5</seealso>, 
-      which are described below.
+      which are described here.
       </p>
   </section>
 
@@ -130,26 +133,33 @@
     <func>
       <name>event(What, Port, Dir, Data) -> ignored</name>
       <name>event(What, Address, Port, Dir, Data) -> ignored</name>
-      <fsummary>This function is called whenever an event occurs in mod_security</fsummary>
+      <fsummary>Called whenever an event occurs in <c>mod_security</c>.</fsummary>
       <type>
-        <v>What  = atom()</v>
-        <v>Port  = integer()</v>
+        <v>What = atom()</v>
+        <v>Port = integer()</v>
         <v>Address = {A,B,C,D} | string() &lt;v>Dir   = string()</v>
-        <v>Data  = [Info]</v>
-        <v>Info  = {Name, Value}</v>
+        <v>Data = [Info]</v>
+        <v>Info = {Name, Value}</v>
       </type>
       <desc>
         <marker id="callback_module_event"></marker>
-        <p><c>event/4</c> or <c>event/4</c> is called whenever an event 
-          occurs in the mod_security Erlang Webserver API module (<c>event/4</c> is
-          called if Address is undefined and <c>event/5</c> otherwise). 
-          The <c>What</c> argument specifies the type of event that has 
-          occurred, and should be one of the following reasons; 
-          <c>auth_fail</c> (a failed user authentication), 
-          <c>user_block</c> (a user is being blocked from access) or 
-          <c>user_unblock</c> (a user is being removed from the block list).</p>
+        <p><c>event/4</c> or <c>event/5</c> is called whenever an event 
+          occurs in the <c>mod_security</c> Erlang web server API module.
+	  (<c>event/4</c> is called if <c>Address</c> is undefined, 
+	  otherwise <c>event/5</c>. 
+          Argument <c>What</c> specifies the type of event that has 
+          occurred and is one of the following reasons:
+          </p>
+	  <taglist>
+       <tag><c>auth_fail</c></tag>
+       <item><p>A failed user authentication.</p></item>
+       <tag><c>user_block</c></tag>
+       <item><p>A user is being blocked from access.</p></item>
+       <tag><c>user_unblock</c></tag>
+       <item><p>A user is being removed from the block list.</p></item>
+     </taglist>
         <note>
-          <p>Note that the <c>user_unblock</c> event is not triggered when 
+          <p>The event <c>user_unblock</c> is not triggered when 
             a user is removed from the block list explicitly using the 
             <c>unblock_user</c> function.</p>
         </note>