diff options
| author | Johannes Weißl <[email protected]> | 2014-01-27 00:43:00 +0100 |
|---|---|---|
| committer | Johannes Weißl <[email protected]> | 2014-01-27 00:43:00 +0100 |
| commit | b246e47d53d4b738fe47df1d7bf71138a8501e02 (patch) | |
| tree | d1deea2f571c23f21f4a5e677d9d22a224bbeacf /lib/ssh/src/ssh.erl | |
| parent | 23790daf1a2d384b0fc11c655fa825151d9fa420 (diff) | |
| download | otp-b246e47d53d4b738fe47df1d7bf71138a8501e02.tar.gz otp-b246e47d53d4b738fe47df1d7bf71138a8501e02.tar.bz2 otp-b246e47d53d4b738fe47df1d7bf71138a8501e02.zip | |
ssh: Fix dialyzer type specs and documentation
Similar to d9ebfb8. The wrong specs were leading to dialyzer warnings
like this in our application since R16B03:
The pattern 'ok' can never match the type {'error',_}.
The pattern {'error', {'already_started', 'ssh'}} can never match the type 'ok'.
The pattern {'error', _} can never match the type {'open_error',_,string(),string()}.
Diffstat (limited to 'lib/ssh/src/ssh.erl')
| -rw-r--r-- | lib/ssh/src/ssh.erl | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/ssh/src/ssh.erl b/lib/ssh/src/ssh.erl index 2685b1553b..891f9cc030 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. %%-------------------------------------------------------------------- |