Editorial updates

SSH application

1 files changed, 44 insertions, 31 deletions

diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml
index f7133e4ba5..9e1f4e908d 100644
--- a/lib/ssh/doc/src/ssh_server_key_api.xml
+++ b/lib/ssh/doc/src/ssh_server_key_api.xml
@@ -23,68 +23,81 @@
       The Initial Developer of the Original Code is Ericsson AB.
     </legalnotice>
     <title>ssh_server_key_api</title>
+    <prepared></prepared>
+    <docno></docno>
+    <date></date>
+    <rev></rev>
   </header>
   <module>ssh_server_key_api</module>
   <modulesummary>
     -behaviour(ssh_server_key_api).
   </modulesummary>
   <description>
-    <p>  Behaviour describing the API for an SSH server's public key handling. By implementing the callbacks defined
-    in this behavior it is possible to customize the SSH server's public key
-    handling. By default the SSH application implements this behavior
-    with help of the standard openssh files, see <seealso marker="SSH_app"> ssh(6)</seealso>.</p>
+    <p>Behaviour describing the API for public key handling of an SSH server. By implementing
+    the callbacks defined in this behavior, the public key handling of an SSH server can
+    be customized. By default the SSH application implements this behavior
+    with help of the standard OpenSSH files,
+    see the <seealso marker="SSH_app"> ssh(6)</seealso> application.</p>
   </description>
 
   <section>
-    <title>DATA TYPES </title>
+    <title>DATA TYPES</title>
 
-    <p>Type definitions that are used more than once in this module
-    and/or abstractions to indicate the intended use of the data
-    type. For more details on public key data types 
-    see the <seealso marker="public_key:public_key_records"> public_key user's guide.</seealso>
+    <p>Type definitions that are used more than once in this module,
+    or abstractions to indicate the intended use of the data
+    type, or both. For more details on public key data types,
+    refer to Section 2 Public Key Records in the
+    <seealso marker="public_key:public_key_records"> public_key user's guide</seealso>.
     </p>
 
-    <p> boolean() = true | false</p>
-    <p> string() = [byte()]</p>
-    <p> public_key() =  #'RSAPublicKey'{} | {integer(),  #'Dss-Parms'{}} | term()</p>
-    <p> private_key() =  #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()</p>
-    <p> public_key_algorithm() =  'ssh-rsa' | 'ssh-dss' | atom()</p>
+<taglist>
+      <tag><c>boolean()</c></tag>
+      <item><p>= <c>true | false</c></p></item>
+      <tag><c>string()</c></tag>
+      <item><p>= <c>[byte()]</c></p></item>
+      <tag><c>public_key()</c></tag>
+      <item><p>= <c>#'RSAPublicKey'{}| {integer(),  #'Dss-Parms'{}}| term()</c></p></item>
+      <tag><c>private_key()</c></tag>
+      <item><p>= <c>#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()</c></p></item>
+      <tag><c>public_key_algorithm()</c></tag>
+      <item><p>= <c>'ssh-rsa'| 'ssh-dss' | atom()</c></p></item>
+    </taglist>
   </section>
 
   <funcs>
     <func>
       <name>Module:host_key(Algorithm, DaemonOptions) ->
       {ok, Key} | {error, Reason}</name>
-      <fsummary>Fetches the hosts private key </fsummary>
+      <fsummary>Fetches the host’s private key.</fsummary>
       <type>
 	<v>Algorithm = public_key_algorithm()</v>
-	<d> Host key algorithm. Should support 'ssh-rsa' | 'ssh-dss' but additional algorithms
+	<d>Host key algorithm. Is to support <c>'ssh-rsa' | 'ssh-dss'</c>, but more algorithms
 	can be handled.</d>
-	<v> DaemonOptions = proplists:proplist() </v>
-	<d>Options provided to  <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso></d>
-	<v> Key = private_key()</v>
-	<d> The private key of the host matching the <c>Algorithm</c></d>
-	<v>Reason = term() </v>
+	<v>DaemonOptions = proplists:proplist()</v>
+	<d>Options provided to  <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>.</d>
+	<v>Key = private_key()</v>
+	<d>Private key of the host matching the <c>Algorithm</c>.</d>
+	<v>Reason = term()</v>
       </type>
       <desc>
-	  <p>Fetches the hosts private key</p>
+	  <p>Fetches the private key of the host.</p>
       </desc>
     </func>
 
     <func>
       <name>Module:is_auth_key(Key, User, DaemonOptions) -> Result</name>
-      <fsummary> Checks if the user key is authorized</fsummary>
+      <fsummary>Checks if the user key is authorized.</fsummary>
       <type>
-	<v> Key = public_key() </v>
-	<d> Normally an RSA or DSA public key but handling of other public keys can be added</d>
-	<v> User = string()</v>
-	<d> The user owning the public key</d>
-	<v> DaemonOptions = proplists:proplist() </v>
-	<d> Options provided to  <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso></d>
-	<v> Result = boolean()</v>
+	<v>Key = public_key()</v>
+	<d>Normally an RSA or DSA public key, but handling of other public keys can be added</d>
+	<v>User = string()</v>
+	<d>User owning the public key.</d>
+	<v>DaemonOptions = proplists:proplist()</v>
+	<d>Options provided to  <seealso marker="ssh#daemon-2">ssh:daemon/[2,3]</seealso>.</d>
+	<v>Result = boolean()</v>
       </type>
       <desc>
-	 <p> Checks if the user key is authorized </p>
+	 <p>Checks if the user key is authorized.</p>
       </desc>
     </func>