[inets] Some documentation cleanup

OTP-9983

1 files changed, 54 insertions, 38 deletions

diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml
index c783b99b23..265a1b8e76 100644
--- a/lib/inets/doc/src/mod_alias.xml
+++ b/lib/inets/doc/src/mod_alias.xml
@@ -1,10 +1,10 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE erlref SYSTEM "erlref.dtd">
 
 <erlref>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2012</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -32,8 +32,11 @@
   <modulesummary>URL aliasing.</modulesummary>
   <description>
     <p>Erlang Webserver Server internal API for handling of things
-      such as interaction data exported by the mod_alias module.</p>
+    such as interaction data exported by the mod_alias module.</p>
+
+    <marker id="default_index"></marker>
   </description>
+
   <funcs>
     <func>
       <name>default_index(ConfigDB, Path) -> NewPath</name>
@@ -45,17 +48,20 @@
       <desc>
         <marker id="default_index"></marker>
         <p>If <c>Path</c> is a directory, <c>default_index/2</c>, it starts
-          searching for resources or files that are specified in the config
-          directive DirectoryIndex.
-          If an appropriate resource or file is found, it is appended to
-          the end of <c>Path</c> and then returned. <c>Path</c> is
-          returned unaltered, if no appropriate
-          file is found, or if <c>Path</c> is not a directory.
-          <c>config_db()</c> is the server config file in ETS table format
-          as described in
-          <seealso marker="http_server">Inets Users Guide.</seealso>.</p>
+	searching for resources or files that are specified in the config
+	directive DirectoryIndex.
+	If an appropriate resource or file is found, it is appended to
+	the end of <c>Path</c> and then returned. <c>Path</c> is
+	returned unaltered, if no appropriate
+	file is found, or if <c>Path</c> is not a directory.
+	<c>config_db()</c> is the server config file in ETS table format
+	as described in
+	<seealso marker="http_server">Inets Users Guide.</seealso>.</p>
+
+	<marker id="path"></marker>
       </desc>
     </func>
+
     <func>
       <name>path(PathData, ConfigDB, RequestURI) -> Path</name>
       <fsummary>Return the actual file path to a URL.</fsummary>
@@ -67,15 +73,19 @@
       <desc>
         <marker id="path"></marker>
         <p><c>path/3</c> returns the actual file <c>Path</c> in the
-          <c>RequestURI</c> (See RFC 1945). If the interaction data
-          <c>{real_name,{Path,AfterPath}}</c> has been exported by
-          mod_alias;
-          <c>Path</c> is returned. If no interaction data has been
-          exported, ServerRoot is used to
-          generate a file <c>Path</c>. <c>config_db()</c> and
-          <c>interaction_data()</c> are as defined in <seealso marker="http_server">Inets Users Guide</seealso>.</p>
+	<c>RequestURI</c> (See RFC 1945). If the interaction data
+	<c>{real_name,{Path,AfterPath}}</c> has been exported by
+	mod_alias;
+	<c>Path</c> is returned. If no interaction data has been
+	exported, ServerRoot is used to
+	generate a file <c>Path</c>. <c>config_db()</c> and
+	<c>interaction_data()</c> are as defined in 
+	<seealso marker="http_server">Inets Users Guide</seealso>.</p>
+
+	<marker id="real_name"></marker>
       </desc>
     </func>
+
     <func>
       <name>real_name(ConfigDB, RequestURI, Aliases) -> Ret</name>
       <fsummary>Expand a request uri using  Alias config directives.</fsummary>
@@ -89,18 +99,24 @@
       <desc>
         <marker id="real_name"></marker>
         <p><c>real_name/3</c> traverses <c>Aliases</c>, typically
-          extracted from <c>ConfigDB</c>, and matches each
-          <c>FakeName</c> with <c>RequestURI</c>. If a match is found 
-          <c>FakeName</c> is replaced with <c>RealName</c> in the
-          match. The resulting path is split into two parts, that
-          is <c>ShortPath</c> and <c>AfterPath</c> as defined in <seealso marker="httpd_util#split_path">httpd_util:split_path/1</seealso>. 
-          <c>Path</c> is generated from <c>ShortPath</c>, that is
-          the result from <seealso marker="#default_index">default_index/2</seealso> with
-          <c>ShortPath</c> as an argument.
-          <c>config_db()</c> is the server config file in ETS table
-          format as described in <seealso marker="http_server">Inets User Guide.</seealso>. </p>
+	extracted from <c>ConfigDB</c>, and matches each
+	<c>FakeName</c> with <c>RequestURI</c>. If a match is found 
+	<c>FakeName</c> is replaced with <c>RealName</c> in the
+	match. The resulting path is split into two parts, that
+	is <c>ShortPath</c> and <c>AfterPath</c> as defined in 
+	<seealso marker="httpd_util#split_path">httpd_util:split_path/1</seealso>. 
+	<c>Path</c> is generated from <c>ShortPath</c>, that is
+	the result from 
+	<seealso marker="#default_index">default_index/2</seealso> with
+	<c>ShortPath</c> as an argument.
+	<c>config_db()</c> is the server config file in ETS table
+	format as described in 
+	<seealso marker="http_server">Inets User Guide.</seealso>. </p>
+
+	<marker id="real_script_name"></marker>
       </desc>
     </func>
+
     <func>
       <name>real_script_name(ConfigDB,RequestURI,ScriptAliases) -> Ret</name>
       <fsummary>Expand a request uri using ScriptAlias config directives.</fsummary>
@@ -114,15 +130,15 @@
       <desc>
         <marker id="real_script_name"></marker>
         <p><c>real_name/3</c> traverses <c>ScriptAliases</c>,
-          typically extracted from <c>ConfigDB</c>, and matches each
-          <c>FakeName</c> with <c>RequestURI</c>. If a match is found
-          <c>FakeName</c> is replaced with <c>RealName</c> in the
-          match. If the resulting match is not an executable script
-          <c>not_a_script</c> is returned. If it is a script the
-          resulting script path is in two parts, that is
-          <c>ShortPath</c> and <c>AfterPath</c> as defined in <seealso marker="httpd_util#split_script_path">httpd_util:split_script_path/1</seealso>.
-          <c>config_db()</c> is the server config file in ETS table
-          format as described in <seealso marker="http_server">Inets Users Guide.</seealso>.</p>
+	typically extracted from <c>ConfigDB</c>, and matches each
+	<c>FakeName</c> with <c>RequestURI</c>. If a match is found
+	<c>FakeName</c> is replaced with <c>RealName</c> in the
+	match. If the resulting match is not an executable script
+	<c>not_a_script</c> is returned. If it is a script the
+	resulting script path is in two parts, that is
+	<c>ShortPath</c> and <c>AfterPath</c> as defined in <seealso marker="httpd_util#split_script_path">httpd_util:split_script_path/1</seealso>.
+	<c>config_db()</c> is the server config file in ETS table
+	format as described in <seealso marker="http_server">Inets Users Guide.</seealso>.</p>
       </desc>
     </func>
   </funcs>