add rdoc files

igrigorik · Mar 9, 2009 · ccd4b48 · ccd4b48
1 parent 737a507
commit ccd4b48
Show file tree

Hide file tree

Showing 44 changed files with 2,955 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/doc/classes/Jack.html b/doc/classes/Jack.html
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Jack</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Jack</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/jack/beanstalk_connection_rb.html">
+                lib/jack/beanstalk_connection.rb
+                </a>
+        <br />
+                <a href="../files/lib/jack/connection_rb.html">
+                lib/jack/connection.rb
+                </a>
+        <br />
+                <a href="../files/lib/jack/errors_rb.html">
+                lib/jack/errors.rb
+                </a>
+        <br />
+                <a href="../files/lib/jack/job_rb.html">
+                lib/jack/job.rb
+                </a>
+        <br />
+                <a href="../files/lib/jack_rb.html">
+                lib/jack.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Jack/VERSION.html" class="link">Jack::VERSION</a><br />
+Class <a href="Jack/BeanstalkConnection.html" class="link">Jack::BeanstalkConnection</a><br />
+Class <a href="Jack/Connection.html" class="link">Jack::Connection</a><br />
+Class <a href="Jack/Disconnected.html" class="link">Jack::Disconnected</a><br />
+Class <a href="Jack/InvalidCommand.html" class="link">Jack::InvalidCommand</a><br />
+Class <a href="Jack/Job.html" class="link">Jack::Job</a><br />
+
+    </div>
+
+
+
+
+
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
diff --git a/doc/classes/Jack/BeanstalkConnection.html b/doc/classes/Jack/BeanstalkConnection.html
@@ -0,0 +1,210 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Jack::BeanstalkConnection</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Jack::BeanstalkConnection</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/jack/beanstalk_connection_rb.html">
+                lib/jack/beanstalk_connection.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                EM::Connection
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">connection_completed</a>&nbsp;&nbsp;
+      <a href="#M000002">receive_data</a>&nbsp;&nbsp;
+      <a href="#M000003">send</a>&nbsp;&nbsp;
+      <a href="#M000004">send_with_data</a>&nbsp;&nbsp;
+      <a href="#M000005">unbind</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">client</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="BeanstalkConnection.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('BeanstalkConnection.src/M000001.html');return false;">
+          <span class="method-name">connection_completed</span><span class="method-args">()</span>
+          </a>
+        </div>
+
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="BeanstalkConnection.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('BeanstalkConnection.src/M000002.html');return false;">
+          <span class="method-name">receive_data</span><span class="method-args">(data)</span>
+          </a>
+        </div>
+
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="BeanstalkConnection.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('BeanstalkConnection.src/M000003.html');return false;">
+          <span class="method-name">send</span><span class="method-args">(command, *args)</span>
+          </a>
+        </div>
+
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="BeanstalkConnection.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('BeanstalkConnection.src/M000004.html');return false;">
+          <span class="method-name">send_with_data</span><span class="method-args">(command, data, *args)</span>
+          </a>
+        </div>
+
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="BeanstalkConnection.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('BeanstalkConnection.src/M000005.html');return false;">
+          <span class="method-name">unbind</span><span class="method-args">()</span>
+          </a>
+        </div>
+
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
diff --git a/doc/classes/Jack/BeanstalkConnection.src/M000001.html b/doc/classes/Jack/BeanstalkConnection.src/M000001.html
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>connection_completed (Jack::BeanstalkConnection)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>   <span class="ruby-comment cmt"># File lib/jack/beanstalk_connection.rb, line 7</span>
+7:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connection_completed</span>
+8:       <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">connected</span>
+9:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
diff --git a/doc/classes/Jack/BeanstalkConnection.src/M000002.html b/doc/classes/Jack/BeanstalkConnection.src/M000002.html
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>receive_data (Jack::BeanstalkConnection)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/jack/beanstalk_connection.rb, line 11</span>
+11:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">receive_data</span>(<span class="ruby-identifier">data</span>)
+12:       <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">received</span>(<span class="ruby-identifier">data</span>)
+13:     <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>