From 5d6805703035d88a44265b3e0e1337d4e8388c10 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Tue, 5 May 2015 11:59:07 +0200 Subject: ssh: No description in v-tag --- lib/ssh/doc/src/ssh_channel.xml | 20 +++++++++++--------- 1 file 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 @@ Makes a synchronous call to a channel. ChannelRef = pid() - As returned by start_link/4 + As returned by ssh_channel:start_link/4 Msg = term() Timeout = timeout() Reply = term() @@ -112,7 +112,7 @@ ChannelRef and returns ok. ChannelRef = pid() - As returned by start_link/4 + As returned by ssh_channel:start_link/4 Msg = term() @@ -129,8 +129,8 @@ enter_loop(State) -> _ Makes an existing process an ssh_channel process. - State = term() - as returned by - ssh_channel:init/1 + State = term() + as returned by ssh_channel:init/1

Makes an existing process an ssh_channel @@ -188,7 +188,7 @@ reply(Client, Reply) -> _ Sends a reply to a client. - Client - opaque to the user, see explanation below + Client = opaque() Reply = term() @@ -313,13 +313,15 @@ ssh_channel:call/[2,3]. Msg = term() - From = Opaque to the user, is to be used as argument to - ssh_channel:reply/2 + From = opaque() + Is to be used as argument to + ssh_channel:reply/2 State = term() Result = {reply, Reply, NewState} | {reply, Reply, NewState, timeout()} | {noreply, NewState} | {noreply , NewState, timeout()} | {stop, Reason, Reply, NewState} | {stop, Reason, NewState} - Reply = term() - will be the return value of ssh_channel:call/[2,3] + Reply = term() + Will be the return value of ssh_channel:call/[2,3] NewState = term() Reason = term() @@ -418,7 +420,7 @@ Module:terminate(Reason, State) -> _ Does cleaning up before channel process termination. - + Reason = term() State = term() -- cgit v1.2.3