From 42cc43a5e88ac578249def663f665723ecc53c46 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Tue, 16 Jun 2015 15:54:07 +0200
Subject: ssh: Modernize type definitions

---
 lib/ssh/doc/src/ssh_connection.xml | 34 +++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

(limited to 'lib/ssh/doc/src')

diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml
index 5422633dc3..e2b4e2ceb7 100644
--- a/lib/ssh/doc/src/ssh_connection.xml
+++ b/lib/ssh/doc/src/ssh_connection.xml
@@ -85,7 +85,7 @@
       <tag><em>data_events()</em></tag>
        <item>
 	 <taglist>
-	   <tag><c><![CDATA[{data, ssh_channel_id(), ssh_data_type_code(), binary() = Data}]]></c></tag>
+	   <tag><c><![CDATA[{data, ssh_channel_id(), ssh_data_type_code(), Data :: binary()}]]></c></tag>
 	   <item><p>Data has arrived on the channel. This event is sent as a
 	   result of calling <seealso marker="ssh_connection#send-3">
 	   ssh_connection:send/[3,4,5]</seealso>.</p></item>
@@ -110,15 +110,15 @@
 	referred to are on OS-level and not something generated by an
 	Erlang program.</p></item>
 
-	<tag><c><![CDATA[{exit_signal, ssh_channel_id(), string() = ExitSignal, string() = ErrorMsg,
-	string() = LanguageString}]]></c></tag>
+	<tag><c><![CDATA[{exit_signal, ssh_channel_id(), ExitSignal :: string(), ErrorMsg ::string(),
+	LanguageString :: string()}]]></c></tag>
 
 	<item><p>A remote execution can terminate violently because of a signal.
 	Then this message can be received. For details on valid string
 	values, see <url href="http://www.ietf.org/rfc/rfc4254.txt">RFC 4254</url>
 	Section 6.10, which shows a special case of these signals.</p></item>
 
-	<tag><c><![CDATA[{exit_status, ssh_channel_id(), integer() = ExitStatus}]]></c></tag>
+	<tag><c><![CDATA[{exit_status, ssh_channel_id(), ExitStatus :: integer()}]]></c></tag>
 	<item><p>When the command running at the other end terminates, the
 	following message can be sent to return the exit status of the
 	command. A zero <c>exit_status</c> usually means that the command
@@ -148,18 +148,18 @@
        with the boolean value of <c>WantReply</c> as the second argument.</p>
 
        <taglist>
-	 <tag><c><![CDATA[{env, ssh_channel_id(), boolean() = WantReply,
-	 string() = Var, string() = Value}]]></c></tag>
+	 <tag><c><![CDATA[{env, ssh_channel_id(), WantReply :: boolean(),
+	 Var ::string(), Value :: string()}]]></c></tag>
 	 <item><p>Environment variables can be passed to the shell/command
 	 to be started later. This event is sent as a result of calling <seealso
 	 marker="ssh_connection#setenv-5"> ssh_connection:setenv/5</seealso>.
 	 </p></item>
 
 	 <tag><c><![CDATA[{pty, ssh_channel_id(),
-	 boolean() = WantReply, {string() = Terminal, integer() = CharWidth,
-	 integer() = RowHeight, integer() = PixelWidth, integer() = PixelHeight,
-	 [{atom() | integer() = Opcode,
-	 integer() = Value}] = TerminalModes}}]]></c></tag>
+	 WantReply :: boolean(), {Terminal :: string(), CharWidth :: integer(),
+	 RowHeight :: integer(), PixelWidth :: integer(), PixelHeight :: integer(),
+	 TerminalModes :: [{Opcode  :: atom() | integer(),
+	 Value :: integer()}]}}]]></c></tag>
 	 <item><p>A pseudo-terminal has been requested for the
 	 session. <c>Terminal</c> is the value of the TERM environment
 	 variable value, that is, <c>vt100</c>. Zero dimension parameters must
@@ -174,20 +174,20 @@
 	 echo</c>. This event is sent as a result of calling <seealso
 	 marker="ssh_connection#ptty_alloc/4">ssh_connection:ptty_alloc/4</seealso>.</p></item>
 
-	 <tag><c><![CDATA[{shell, boolean() = WantReply}]]></c></tag>
+	 <tag><c><![CDATA[{shell, WantReply :: boolean()}]]></c></tag>
 	 <item><p>This message requests that the user default shell
 	 is started at the other end. This event is sent as a result of calling
 	 <seealso marker="ssh_connection#shell-2"> ssh_connection:shell/2</seealso>.
 	 </p></item>
 
-	 <tag><c><![CDATA[{window_change, ssh_channel_id(), integer() = CharWidth,
-	 integer() = RowHeight, integer() = PixWidth, integer() = PixHeight}]]></c></tag>
+	 <tag><c><![CDATA[{window_change, ssh_channel_id(), CharWidth() :: integer(),
+	 RowHeight :: integer(), PixWidth :: integer(), PixHeight :: integer()}]]></c></tag>
 	 <item><p>When the window (terminal) size changes on the client
 	 side, it <em>can</em> send a message to the server side to inform it of
 	 the new dimensions. No API function generates this event.</p></item>
      
 	 <tag><c><![CDATA[{exec, ssh_channel_id(),
-	 boolean() = WantReply, string() = Cmd}]]></c></tag>
+	 WantReply :: boolean(), Cmd :: string()}]]></c></tag>
 	 <item><p>This message requests that the server starts
 	 execution of the given command. This event is sent as a result of calling <seealso
 	 marker="ssh_connection#exec-4">ssh_connection:exec/4 </seealso>.
@@ -256,7 +256,7 @@
 
        <taglist>
 	 <tag><c>N x {ssh_cm, ssh_connection_ref(),
-	 {data, ssh_channel_id(), ssh_data_type_code(), binary() = Data}}</c></tag>
+	 {data, ssh_channel_id(), ssh_data_type_code(), Data :: binary()}}</c></tag>
 	 <item><p>The result of executing the command can be only one line
 	 or thousands of lines depending on the command.</p></item>
 
@@ -265,12 +265,12 @@
 
 	 <tag><c>0 or 1 x {ssh_cm,
 	 ssh_connection_ref(), {exit_signal,
-	 ssh_channel_id(), string() = ExitSignal, string() = ErrorMsg, string() = LanguageString}}</c></tag>
+	 ssh_channel_id(), ExitSignal :: string(), ErrorMsg :: string(), LanguageString :: string()}}</c></tag>
 	 <item><p>Not all systems send signals. For details on valid string
 	 values, see RFC 4254, Section 6.10</p></item>
 	 
 	  <tag><c>0 or 1 x {ssh_cm, ssh_connection_ref(), {exit_status,
-	  ssh_channel_id(), integer() = ExitStatus}}</c></tag>
+	  ssh_channel_id(), ExitStatus :: integer()}}</c></tag>
 	  <item><p>It is recommended by the SSH Connection Protocol to send this
 	  message, but that is not always the case.</p></item>
 
-- 
cgit v1.2.3