diff options
| author | Henrik Nord <[email protected]> | 2014-02-14 15:58:44 +0100 |
|---|---|---|
| committer | Henrik Nord <[email protected]> | 2014-02-14 15:59:01 +0100 |
| commit | 90f9fb016d199ef518737d1cd85c364a93891bd6 (patch) | |
| tree | 537036777fed463880c750010cd3bc4115d3e86c | |
| parent | ed2c247a0f1b30f899929ed1231566b29d86dc47 (diff) | |
| parent | b246e47d53d4b738fe47df1d7bf71138a8501e02 (diff) | |
| download | otp-90f9fb016d199ef518737d1cd85c364a93891bd6.tar.gz otp-90f9fb016d199ef518737d1cd85c364a93891bd6.tar.bz2 otp-90f9fb016d199ef518737d1cd85c364a93891bd6.zip | |
Merge branch 'weisslj/ssh-spec-doc-fixes'
* weisslj/ssh-spec-doc-fixes:
ssh: Fix dialyzer type specs and documentation
OTP-11705
| -rw-r--r-- | lib/ssh/doc/src/ssh.xml | 5 | ||||
| -rw-r--r-- | lib/ssh/src/ssh.erl | 6 | ||||
| -rw-r--r-- | lib/ssh/src/ssh_connection_handler.erl | 2 |
3 files changed, 8 insertions, 5 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 5d5f2e5b91..eaf96d0230 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -367,8 +367,11 @@ </func> <func> - <name>stop() -> ok </name> + <name>stop() -> ok | {error, Reason}</name> <fsummary>Stops the SSH application.</fsummary> + <type> + <v>Reason = term()</v> + </type> <desc> <p>Stops the SSH application. See also <seealso marker="kernel:application">application(3)</seealso></p> diff --git a/lib/ssh/src/ssh.erl b/lib/ssh/src/ssh.erl index 9f571adba2..d50d5a0cb3 100644 --- a/lib/ssh/src/ssh.erl +++ b/lib/ssh/src/ssh.erl @@ -32,8 +32,8 @@ shell/1, shell/2, shell/3]). %%-------------------------------------------------------------------- --spec start() -> ok. --spec start(permanent | transient | temporary) -> ok. +-spec start() -> ok | {error, term()}. +-spec start(permanent | transient | temporary) -> ok | {error, term()}. %% %% Description: Starts the ssh application. Default type %% is temporary. see application(3) @@ -51,7 +51,7 @@ start(Type) -> application:start(ssh, Type). %%-------------------------------------------------------------------- --spec stop() -> ok. +-spec stop() -> ok | {error, term()}. %% %% Description: Stops the ssh application. %%-------------------------------------------------------------------- diff --git a/lib/ssh/src/ssh_connection_handler.erl b/lib/ssh/src/ssh_connection_handler.erl index 3462b98172..070a2db5a8 100644 --- a/lib/ssh/src/ssh_connection_handler.erl +++ b/lib/ssh/src/ssh_connection_handler.erl @@ -157,7 +157,7 @@ init([Role, Socket, SshOpts]) -> %%-------------------------------------------------------------------- -spec open_channel(pid(), string(), iodata(), integer(), integer(), - timeout()) -> {open, channel_id()} | {open_error, term(), string(), string()}. + timeout()) -> {open, channel_id()} | {error, term()}. %%-------------------------------------------------------------------- open_channel(ConnectionHandler, ChannelType, ChannelSpecificData, InitialWindowSize, |