diff options
| author | Ingela Anderton Andin <[email protected]> | 2015-05-05 11:59:07 +0200 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2015-05-05 14:45:08 +0200 |
| commit | 5d6805703035d88a44265b3e0e1337d4e8388c10 (patch) | |
| tree | a5f6bbb49c7103747dbbc07e4dec87431b18dc19 /lib/ssh/doc | |
| parent | fd89608b7ae337bc29712c14c90de8d1c82ea667 (diff) | |
| download | otp-5d6805703035d88a44265b3e0e1337d4e8388c10.tar.gz otp-5d6805703035d88a44265b3e0e1337d4e8388c10.tar.bz2 otp-5d6805703035d88a44265b3e0e1337d4e8388c10.zip | |
ssh: No description in v-tag
Diffstat (limited to 'lib/ssh/doc')
| -rw-r--r-- | lib/ssh/doc/src/ssh_channel.xml | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml index 2205eb4279..b8a03c350a 100644 --- a/lib/ssh/doc/src/ssh_channel.xml +++ b/lib/ssh/doc/src/ssh_channel.xml @@ -88,7 +88,7 @@ <fsummary>Makes a synchronous call to a channel.</fsummary> <type> <v>ChannelRef = pid() </v> - <d>As returned by <c>start_link/4</c></d> + <d>As returned by <seealso marker = "#start_link-4">ssh_channel:start_link/4</seealso></d> <v>Msg = term()</v> <v>Timeout = timeout()</v> <v>Reply = term()</v> @@ -112,7 +112,7 @@ ChannelRef and returns ok.</fsummary> <type> <v>ChannelRef = pid()</v> - <d>As returned by <c>start_link/4</c></d> + <d>As returned by <seealso marker = "#start_link-4">ssh_channel:start_link/4</seealso></d> <v>Msg = term()</v> </type> <desc> @@ -129,8 +129,8 @@ <name>enter_loop(State) -> _ </name> <fsummary>Makes an existing process an ssh_channel process.</fsummary> <type> - <v>State = term() - as returned by - <seealso marker = "#init-1">ssh_channel:init/1</seealso></v> + <v>State = term()</v> + <d>as returned by <seealso marker = "#init-1">ssh_channel:init/1</seealso></d> </type> <desc> <p>Makes an existing process an <c>ssh_channel</c> @@ -188,7 +188,7 @@ <name>reply(Client, Reply) -> _</name> <fsummary>Sends a reply to a client.</fsummary> <type> - <v>Client - opaque to the user, see explanation below</v> + <v>Client = opaque()</v> <v>Reply = term()</v> </type> <desc> @@ -313,13 +313,15 @@ <c>ssh_channel:call/[2,3]</c>.</fsummary> <type> <v>Msg = term()</v> - <v>From = Opaque to the user, is to be used as argument to - ssh_channel:reply/2</v> + <v>From = opaque()</v> + <d>Is to be used as argument to + <seealso marker="#reply-2">ssh_channel:reply/2</seealso></d> <v>State = term()</v> <v>Result = {reply, Reply, NewState} | {reply, Reply, NewState, timeout()} | {noreply, NewState} | {noreply , NewState, timeout()} | {stop, Reason, Reply, NewState} | {stop, Reason, NewState} </v> - <v>Reply = term() - will be the return value of ssh_channel:call/[2,3]</v> + <v>Reply = term()</v> + <d>Will be the return value of <seealso marker="#call-2">ssh_channel:call/[2,3]</seealso></d> <v>NewState = term()</v> <v>Reason = term()</v> </type> @@ -418,7 +420,7 @@ <func> <name>Module:terminate(Reason, State) -> _</name> <fsummary>Does cleaning up before channel process termination. -</fsummary> + </fsummary> <type> <v>Reason = term()</v> <v>State = term()</v> |