Skip to content

Kuba/ssh/doc fixes 09 05 #10170

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: maint
Choose a base branch
from
Open

Kuba/ssh/doc fixes 09 05 #10170

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15a35da
ssh: doc typo fix
u3s Sep 5, 2025
1eba2fc
ssh: (doc) add missing function headlines in ssh_file
u3s Sep 5, 2025
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
12 changes: 11 additions & 1 deletion lib/ssh/src/ssh_file.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ handler.
Such another callback module could be used by setting the option
[`key_cb`](`t:ssh:key_cb_common_option/0`) when starting a client or a server
(with for example [ssh:connect](`ssh:connect/3`), [ssh:daemon](`ssh:daemon/2`)
of [ssh:shell](`ssh:shell/1`) ).
or [ssh:shell](`ssh:shell/1`) ).

> #### Note {: .info }
>
Expand Down Expand Up @@ -257,6 +257,8 @@ call that initiates an ssh connection.

%%%---------------- SERVER API ------------------------------------
-doc """
Fetches the private key of the host.

**Types and description**

See the api description in
Expand Down Expand Up @@ -285,6 +287,8 @@ host_key(Algorithm, Opts) ->

%%%................................................................
-doc """
Checks if the user key is authorized.

**Types and description**

See the api description in
Expand Down Expand Up @@ -321,6 +325,8 @@ is_auth_key(Key0, User, Opts) ->

%%%---------------- CLIENT API ------------------------------------
-doc """
Fetches the users public key matching the Algorithm.

**Types and description**

See the api description in
Expand Down Expand Up @@ -356,6 +362,8 @@ user_key(Algorithm, Opts) ->
%%%................................................................
%%% New style (with port number)
-doc """
Checks if a host key is trusted.

**Types and description**

See the api description in
Expand Down Expand Up @@ -395,6 +403,8 @@ is_host_key(Key0, Hosts0, Port, Algorithm, Opts) ->

%%%----------------------------------------------------------------
-doc """
Adds a host key to the set of trusted host keys.

**Types and description**

See the api description in
Expand Down
Loading