Merge branch 'ia/ssh/doc/types'

* ia/ssh/doc/types:
  ssh: Align "=" sign in type declarations to decided policy

7 files changed, 90 insertions, 91 deletions

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index c7d7db0e30..df13442fc6 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -57,29 +57,28 @@
     this module, or abstractions to indicate the intended use of the data
     type, or both:</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>ssh_daemon_ref()</c></tag>
-      <item><p>Opaque to the user,
-    returned by <c>ssh:daemon/[1,2,3]</c></p></item>
-      <tag><c>ssh_connection_ref()</c></tag>
-      <item><p>Opaque to the user,
-    returned by <c>ssh:connect/3</c></p></item>
-      <tag><c>ip_address()</c></tag>
+      <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>ssh_daemon_ref() =</c></tag>
+      <item><p>opaque() -
+      as returned by <c>ssh:daemon/[1,2,3]</c></p></item>
+      <tag><c>ssh_connection_ref() =</c></tag>
+      <item><p>opaque() - as returned by <c>ssh:connect/3</c></p></item>
+      <tag><c>ip_address() =</c></tag>
       <item><p><c>inet::ip_address</c></p></item>
-      <tag><c>subsystem_spec()</c></tag>
-      <item><p>= <c>{subsystem_name(),
-    {channel_callback(), channel_init_args()}}</c></p></item>
-      <tag><c>subsystem_name()</c></tag>
-      <item><p>= <c>string()</c></p></item>
-      <tag><c>channel_callback()</c></tag>
-      <item><p>= <c>atom()</c> - Name of the Erlang module
-    implementing the subsystem using the <c>ssh_channel</c> behavior, see
-    <seealso marker="ssh_channel">ssh_channel(3)</seealso></p></item>
-      <tag><c>channel_init_args()</c></tag>
-      <item><p>= <c>list()</c></p></item>
+      <tag><c>subsystem_spec() =</c></tag>
+      <item><p><c>{subsystem_name(),
+      {channel_callback(), channel_init_args()}}</c></p></item>
+      <tag><c>subsystem_name() =</c></tag>
+      <item><p><c>string()</c></p></item>
+      <tag><c>channel_callback() =</c></tag>
+      <item><p><c>atom()</c> - Name of the Erlang module
+      implementing the subsystem using the <c>ssh_channel</c> behavior, see
+      <seealso marker="ssh_channel">ssh_channel(3)</seealso></p></item>
+      <tag><c>channel_init_args() =</c></tag>
+      <item><p><c>list()</c></p></item>
      </taglist>
 </section>
 
diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml
index b8a03c350a..2fdecf9072 100644
--- a/lib/ssh/doc/src/ssh_channel.xml
+++ b/lib/ssh/doc/src/ssh_channel.xml
@@ -62,22 +62,22 @@
     type, or both:</p>
     
     <taglist>
-      <tag><c>boolean()</c></tag>
-      <item><p>= <c>true | false</c></p></item>
-      <tag><c>string()</c></tag>
-      <item><p>= list of ASCII characters</p></item>
-      <tag><c>timeout()</c></tag>
-      <item><p>= <c>infinity | integer()</c> in milliseconds</p></item>
-      <tag><c>ssh_connection_ref()</c></tag>
-      <item><p>Opaque to the user, returned by
-    <c>ssh:connect/3</c> or sent to an SSH channel process</p></item>
-      <tag><c>ssh_channel_id()</c></tag>
-      <item><p>= <c>integer()</c></p></item>
-      <tag><c>ssh_data_type_code()</c></tag>
-      <item><p>= <c>1</c> ("stderr") | <c>0</c> ("normal") are
-    the valid values,
-    see <url href="http://www.ietf.org/rfc/rfc4254.txt">RFC 4254</url>
-    Section 5.2</p></item>
+      <tag><c>boolean() =</c></tag>
+      <item><p><c>true | false</c></p></item>
+      <tag><c>string() =</c></tag>
+      <item><p>list of ASCII characters</p></item>
+      <tag><c>timeout() =</c></tag>
+      <item><p><c>infinity | integer()</c> in milliseconds</p></item>
+      <tag><c>ssh_connection_ref() =</c></tag>
+      <item><p>opaque() -as returned by
+      <c>ssh:connect/3</c> or sent to an SSH channel process</p></item>
+      <tag><c>ssh_channel_id() =</c></tag>
+      <item><p><c>integer()</c></p></item>
+      <tag><c>ssh_data_type_code() =</c></tag>
+      <item><p><c>1</c> ("stderr") | <c>0</c> ("normal") are
+      the valid values,
+      see <url href="http://www.ietf.org/rfc/rfc4254.txt">RFC 4254</url>
+      Section 5.2</p></item>
     </taglist>
   </section>
 
diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml
index a8dda042c9..9a892d71fd 100644
--- a/lib/ssh/doc/src/ssh_client_key_api.xml
+++ b/lib/ssh/doc/src/ssh_client_key_api.xml
@@ -50,16 +50,16 @@
     <seealso marker="public_key:public_key_records"> public_key user's guide:</seealso>
     </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>
+      <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>
 
diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml
index 669a361db9..5422633dc3 100644
--- a/lib/ssh/doc/src/ssh_connection.xml
+++ b/lib/ssh/doc/src/ssh_connection.xml
@@ -56,29 +56,29 @@
     type, or both:</p>
 
     <taglist>
-      <tag><c>boolean()</c></tag>
-      <item><p>= <c>true | false </c></p></item>
-      <tag><c>string()</c></tag>
-      <item><p>= list of ASCII characters</p></item>
-      <tag><c>timeout()</c></tag>
-      <item><p>= <c>infinity | integer()</c> in milliseconds</p></item>
-      <tag><c>ssh_connection_ref()</c></tag>
-      <item><p>Opaque to the user, returned by
-    <c>ssh:connect/3</c> or sent to an SSH channel processes</p></item>
-      <tag><c>ssh_channel_id()</c></tag>
-      <item><p>= <c>integer()</c></p></item>
-      <tag><c>ssh_data_type_code()</c></tag>
-      <item><p>= <c>1</c> ("stderr") | <c>0</c> ("normal") are
+      <tag><c>boolean() =</c></tag>
+      <item><p><c>true | false </c></p></item>
+      <tag><c>string() =</c></tag>
+      <item><p>list of ASCII characters</p></item>
+      <tag><c>timeout() =</c></tag>
+      <item><p><c>infinity | integer()</c> in milliseconds</p></item>
+      <tag><c>ssh_connection_ref() =</c></tag>
+      <item><p>opaque() -as returned by
+      <c>ssh:connect/3</c> or sent to an SSH channel processes</p></item>
+      <tag><c>ssh_channel_id() =</c></tag>
+      <item><p><c>integer()</c></p></item>
+      <tag><c>ssh_data_type_code() =</c></tag>
+      <item><p><c>1</c> ("stderr") | <c>0</c> ("normal") are
       valid values, see
       <url href="http://www.ietf.org/rfc/rfc4254.txt">RFC 4254</url> Section 5.2.</p></item>
-      <tag><c>ssh_request_status() ssh_request_status()</c></tag>
-      <item><p>= <c>success | failure</c></p></item>
-      <tag><c>event()</c></tag>
-      <item><p>= <c>{ssh_cm, ssh_connection_ref(), ssh_event_msg()}</c></p></item>
-      <tag><c>ssh_event_msg()</c></tag>
-      <item><p>= <c>data_events() | status_events() | terminal_events()</c></p></item>
-      <tag><c>reason()</c></tag>
-      <item><p>= <c>timeout | closed</c></p></item>
+      <tag><c>ssh_request_status() =</c></tag>
+      <item><p> <c>success | failure</c></p></item>
+      <tag><c>event() =</c></tag>
+      <item><p><c>{ssh_cm, ssh_connection_ref(), ssh_event_msg()}</c></p></item>
+      <tag><c>ssh_event_msg() =</c></tag>
+      <item><p><c>data_events() | status_events() | terminal_events()</c></p></item>
+      <tag><c>reason() =</c></tag>
+      <item><p><c>timeout | closed</c></p></item>
     </taglist>
 
     <taglist>
diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml
index 34ce7f7660..73dd90c962 100644
--- a/lib/ssh/doc/src/ssh_server_key_api.xml
+++ b/lib/ssh/doc/src/ssh_server_key_api.xml
@@ -50,20 +50,20 @@
     <seealso marker="public_key:public_key_records"> public_key user's guide</seealso>.
     </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>
+      <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) ->
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 643130fe6b..fc418bc934 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -43,8 +43,8 @@
     </p>
 
     <taglist>
-      <tag><c>ssh_connection_ref()</c></tag>
-      <item><p>Opaque to the user, returned by <c>ssh:connect/3</c></p></item>
+      <tag><c>ssh_connection_ref() =</c></tag>
+      <item><p>opaque() - as returned by <c>ssh:connect/3</c></p></item>
       <tag><c>timeout()</c></tag>
       <item><p>= <c>infinity | integer() in milliseconds. Default infinity.</c></p></item>
     </taglist>
diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml
index bc2660f595..8b2497e6a3 100644
--- a/lib/ssh/doc/src/ssh_sftpd.xml
+++ b/lib/ssh/doc/src/ssh_sftpd.xml
@@ -37,16 +37,16 @@
   <section>
     <title>DATA TYPES</title>
     <taglist>
-      <tag><c>subsystem_spec()</c></tag>
-      <item><p>= <c>{subsystem_name(), {channel_callback(), channel_init_args()}}</c></p></item>
-      <tag><c>subsystem_name()</c></tag>
-      <item><p>= <c>"sftp"</c></p></item>
-      <tag><c>channel_callback()</c></tag>
-      <item><p>= <c>atom()</c> - Name of the Erlang module implementing the subsystem using the
+      <tag><c>subsystem_spec() =</c></tag>
+      <item><p><c>{subsystem_name(), {channel_callback(), channel_init_args()}}</c></p></item>
+      <tag><c>subsystem_name() =</c></tag>
+      <item><p><c>"sftp"</c></p></item>
+      <tag><c>channel_callback() =</c></tag>
+      <item><p><c>atom()</c> - Name of the Erlang module implementing the subsystem using the
       <c>ssh_channel</c> behavior, see the
       <seealso marker="ssh_channel">ssh_channel(3)</seealso> manual page.</p></item>
-      <tag><c>channel_init_args()</c></tag>
-      <item><p>= <c>list()</c> - The one given as argument to function <c>subsystem_spec/1</c>.</p></item>
+      <tag><c>channel_init_args() =</c></tag>
+      <item><p><c>list()</c> - The one given as argument to function <c>subsystem_spec/1</c>.</p></item>
     </taglist>
   </section>
   <funcs>