ssh: polish docs around types

Author: u3s

lib/ssh/src/ssh.erl

@@ -135,7 +135,8 @@ The directory could be changed with the option
                  [{type,<<"Client Options">>},
                   {type,<<"Daemon Options">>},
                   {type,<<"Common Options">>},
-                  {type,<<"Other data types">>}]}).
+                  {type,<<"Deprecated Types">>},
+                  {type,<<"Other Data Types">>}]}).
 
 -include("ssh.hrl").
 -include("ssh_connect.hrl").
@@ -174,8 +175,11 @@ The directory could be changed with the option
 
 %%% "Deprecated" types export:
 -export_type([ssh_daemon_ref/0, ssh_connection_ref/0, ssh_channel_id/0]).
+-doc(#{title => <<"Deprecated Types">>}).
 -opaque ssh_daemon_ref()     :: daemon_ref().
+-doc(#{title => <<"Deprecated Types">>}).
 -opaque ssh_connection_ref() :: connection_ref().
+-doc(#{title => <<"Deprecated Types">>}).
 -opaque ssh_channel_id()     :: channel_id().
 
 
@@ -208,15 +212,15 @@ Opaque data type representing a daemon.
 
 Returned by the functions [`daemon/1,2,3`](`daemon/1`).
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -opaque daemon_ref()         :: pid() .
 -doc """
 Opaque data type representing a channel inside a connection.
 
 Returned by the functions
 [ssh_connection:session_channel/2,4](`ssh_connection:session_channel/2`).
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -opaque channel_id()     :: non_neg_integer().
 -doc """
 Opaque data type representing a connection between a client and a server
@@ -225,7 +229,7 @@ Opaque data type representing a connection between a client and a server
 Returned by the functions [`connect/2,3,4`](`connect/3`) and
 [`ssh_sftp:start_channel/2,3`](`ssh_sftp:start_channel/2`).
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type connection_ref()       :: pid().  % should be -opaque, but that gives problems
 
 %%--------------------------------------------------------------------
@@ -427,13 +431,13 @@ close(ConnectionRef) ->
 %%--------------------------------------------------------------------
 %% Description: Retrieves information about a connection.
 %%---------------------------------------------------------------------
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type version() :: {protocol_version(), software_version()}.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type protocol_version() :: {Major::pos_integer(), Minor::non_neg_integer()}.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type software_version() :: string().
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type conn_info_algs() :: [{kex, kex_alg()}
                            | {hkey, pubkey_alg()}
                            | {encrypt, cipher_alg()}
@@ -451,10 +455,10 @@ Return values from the `connection_info/1` and `connection_info/2` functions.
 In the `option` info tuple are only the options included that differs from the
 default values.
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type conn_info_channels() :: [proplists:proplist()].
 
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type connection_info_tuple() ::
         {client_version, version()}
       | {server_version, version()}
@@ -691,7 +695,7 @@ Return values from the `daemon_info/1` and `daemon_info/2` functions.
 In the `option` info tuple are only the options included that differs from the
 default values.
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type daemon_info_tuple() ::
         {port, inet:port_number()}
       | {ip, inet:ip_address()}

lib/ssh/src/ssh.hrl

@@ -122,16 +122,17 @@
 
 
 %% Types
+-doc(#{title => <<"Other Data Types">>}).
 -type role()                  :: client | server .
 
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type host()                  :: string() | inet:ip_address() | loopback .
 -doc """
 The socket is supposed to be result of a [gen_tcp:connect](`gen_tcp:connect/3`)
 or a [gen_tcp:accept](`gen_tcp:accept/1`). The socket must be in passive mode
 (that is, opened with the option `{active,false})`.
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type open_socket()           :: gen_tcp:socket().
 
 -doc """
@@ -514,7 +515,7 @@ protocol).
 Opaque types that define experimental options that are not to be used in
 products.
 """.
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type opaque_common_options() ::
         {transport, {atom(),atom(),atom()} }
       | {vsn, {non_neg_integer(),non_neg_integer()} }
@@ -547,7 +548,7 @@ risk.
       | gen_tcp:connect_option()
       | ?COMMON_OPTION .
 
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type opaque_client_options() ::
         {keyboard_interact_fun, fun((Name::iodata(),
                                      Instruction::iodata(),
@@ -1149,17 +1150,17 @@ in the User's Guide chapter.
         {failfun, fun((User::string(), PeerAddress::inet:ip_address(), Reason::term()) -> _)}
       | {connectfun, fun((User::string(), PeerAddress::inet:ip_address(), Method::string()) ->_)} .
 
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type opaque_daemon_options()  ::
         {infofun, fun()}
       | opaque_common_options().
 
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type ip_port() :: {inet:ip_address(), inet:port_number()} .
 
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type mod_args() :: {Module::atom(), Args::list()} .
--doc(#{title => <<"Other data types">>}).
+-doc(#{title => <<"Other Data Types">>}).
 -type mod_fun_args() :: {Module::atom(), Function::atom(), Args::list()} .