Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kuba/ssh/doc fixes/otp 19335 #9021

Merged
merged 4 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions lib/ssh/doc/docs.exs
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
[
annotations_for_docs: fn
md ->
if md[:rfc] do
[md[:rfc]]
else
[]
end
end,
## The order of these items determine
## how they are listed in the docs
extras: [
Expand Down
14 changes: 7 additions & 7 deletions lib/ssh/src/ssh.erl
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ To write your own client channel handler, use the behaviour
`m:ssh_client_channel`. For server channel handlers use `m:ssh_server_channel`
behaviour (replaces ssh_daemon_channel).

Both clients and daemons accepts options that controls the exact behaviour. Some
Both clients and daemons accept options that control the exact behaviour. Some
options are common to both. The three sets are called
[Client Options](`t:client_options/0`), [Daemon Options](`t:daemon_options/0`)
and [Common Options](`t:common_options/0`).
Expand Down Expand Up @@ -133,7 +133,7 @@ The directory could be changed with the option
""".
-moduledoc(#{titles =>
[{type,<<"Client Options">>},
{type,<<"Daemon Options (Server Options)">>},
{type,<<"Daemon Options">>},
{type,<<"Common Options">>},
{type,<<"Other data types">>}]}).

Expand Down Expand Up @@ -427,13 +427,13 @@ close(ConnectionRef) ->
%%--------------------------------------------------------------------
%% Description: Retrieves information about a connection.
%%---------------------------------------------------------------------
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-doc(#{title => <<"Other data types">>}).
-type version() :: {protocol_version(), software_version()}.
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-doc(#{title => <<"Other data types">>}).
-type protocol_version() :: {Major::pos_integer(), Minor::non_neg_integer()}.
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-doc(#{title => <<"Other data types">>}).
-type software_version() :: string().
-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-doc(#{title => <<"Other data types">>}).
-type conn_info_algs() :: [{kex, kex_alg()}
| {hkey, pubkey_alg()}
| {encrypt, cipher_alg()}
Expand All @@ -454,7 +454,7 @@ default values.
-doc(#{title => <<"Other data types">>}).
-type conn_info_channels() :: [proplists:proplist()].

-doc(#{title => <<"Other data types">>,equiv => conn_info_channels/0}).
-doc(#{title => <<"Other data types">>}).
-type connection_info_tuple() ::
{client_version, version()}
| {server_version, version()}
Expand Down
Loading
Loading