doc/index.html in ionian-0.6.8 vs doc/index.html in ionian-0.6.9
- old
+ new
@@ -4,11 +4,11 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
File: README
- — Documentation by YARD 0.8.7.4
+ — Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
@@ -59,43 +59,45 @@
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
- <div id="content"><div id='filecontents'><h1>Ionian</h1>
+ <div id="content"><div id='filecontents'>
+<h1 id="label-Ionian">Ionian</h1>
-<p><a href="http://badge.fury.io/rb/ionian"><img src="https://badge.fury.io/rb/ionian.png" alt="Gem Version" /></a></p>
+<p><a href="http://badge.fury.io/rb/ionian"><img
+src="https://badge.fury.io/rb/ionian.png"></a></p>
-<p>A Ruby library to simplify interaction with IO streams. This includes network sockets, file sockets, and serial streams like the console and RS232. Features regular expression matching and notification of received data.</p>
+<p>A Ruby library to simplify interaction with IO streams. This includes
+network sockets, file sockets, and serial streams like the console and
+RS232. Features regular expression matching and notification of received
+data.</p>
-<h2>Supported Ruby Versions</h2>
+<h2 id="label-Supported+Ruby+Versions">Supported Ruby Versions</h2>
+<ul><li>
+<p>MRI >= 2.0.0</p>
+</li></ul>
-<ul>
-<li>MRI >= 2.0.0</li>
-</ul>
+<h2 id="label-Installation">Installation</h2>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ionian'>ionian</span></code></pre>
-<h2>Installation</h2>
+<h2 id="label-Code+Examples">Code Examples</h2>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ionian'>ionian</span>
-</code></pre>
+<h3 id="label-Creating+A+Socket">Creating A Socket</h3>
-<h2>Code Examples</h2>
-
-<h3>Creating A Socket</h3>
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>23</span>
</code></pre>
-<h3>Sending And Receiving Data</h3>
+<h3 id="label-Sending+And+Receiving+Data">Sending And Receiving Data</h3>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>google.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>80</span>
<span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>GET / HTTP/1.1\r\n\r\n</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_match'>read_match</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span> <span class='id identifier rubyid_match'>match</span><span class='semicolon'>;</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
</code></pre>
-<h3>Match Expressions And Named Captures</h3>
+<h3 id="label-Match+Expressions+And+Named+Captures">Match Expressions And Named Captures</h3>
<pre class="code ruby"><code class="ruby"><span class='comment'># A simple IRC client.
</span>
<span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> \
<span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>chat.freenode.net:6667</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
@@ -110,20 +112,19 @@
<span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PRIVMSG #ionian-demo :this is a test\r\n</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_match'>read_match</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span>
- <span class='comment'># Print the body of the server's responses.
+ <span class='comment'># Print the body of the server's responses.
</span> <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_match'>match</span><span class='period'>.</span><span class='id identifier rubyid_msg'>msg</span>
-
+
<span class='comment'># Exit when the server has caught up.
</span> <span class='id identifier rubyid_exit'>exit</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span><span class='period'>.</span><span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>End of /NAMES list.</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span>
-<span class='kw'>end</span>
-</code></pre>
+<span class='kw'>end</span></code></pre>
-<h3>Simple Server</h3>
+<h3 id="label-Simple+Server">Simple Server</h3>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_host'>host</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>localhost:5000</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Server</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>interface:</span> <span class='id identifier rubyid_host'>host</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_client'>client</span><span class='op'>|</span>
<span class='comment'># Greet the connected client.
@@ -135,12 +136,12 @@
</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_all'>read_all</span>
</code></pre>
</div></div>
<div id="footer">
- Generated on Mon Apr 14 18:43:33 2014 by
+ Generated on Fri Oct 31 15:50:43 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.8.7.4 (ruby-2.1.1).
+ 0.8.7.6 (ruby-2.1.4).
</div>
</body>
</html>
\ No newline at end of file