rdoc source documentation (42,50% done!)

ekarak · Mar 1, 2012 · 56e75a5 · 56e75a5
1 parent aceb8c4
commit 56e75a5
Show file tree

Hide file tree

Showing 161 changed files with 53,196 additions and 40,560 deletions.
diff --git a/doc/Ansible.html b/doc/Ansible.html
diff --git a/doc/Ansible/AbstractDevice.html b/doc/Ansible/AbstractDevice.html
@@ -0,0 +1,350 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>Class: Ansible::AbstractDevice</title>
+
+<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+
+
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../index.html">Home</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>ansible_device.rb
+  </ul>
+</nav>
+
+
+  </div>
+
+  <div id="class-metadata">
+
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+
+  <p class="link"><a href="../Object.html">Object</a>
+
+</nav>
+
+
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+
+    <li><a href="#method-c-new">::new</a>
+
+  </ul>
+</nav>
+
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+
+    <li class="file"><a href="../README.html">README</a>
+
+    <li class="file"><a href="../license/LICENSE.html">LICENSE</a>
+
+    <li class="file"><a href="../license/gpl_txt.html">gpl</a>
+
+    <li class="file"><a href="../license/lgpl_txt.html">lgpl</a>
+
+    <li class="file"><a href="../monit/monitrc-ansible.html">monitrc-ansible</a>
+
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+
+    <li><a href="../Ansible.html">Ansible</a>
+
+    <li><a href="../Ansible/AbstractDevice.html">Ansible::AbstractDevice</a>
+
+    <li><a href="../Ansible/AnsibleCallback.html">Ansible::AnsibleCallback</a>
+
+    <li><a href="../Ansible/AnsibleValue.html">Ansible::AnsibleValue</a>
+
+    <li><a href="../Ansible/CommandChain.html">Ansible::CommandChain</a>
+
+    <li><a href="../Ansible/Dimmer.html">Ansible::Dimmer</a>
+
+    <li><a href="../Ansible/KNX.html">Ansible::KNX</a>
+
+    <li><a href="../Ansible/KNX/Canonical_1bit.html">Ansible::KNX::Canonical_1bit</a>
+
+    <li><a href="../Ansible/KNX/DPT1.html">Ansible::KNX::DPT1</a>
+
+    <li><a href="../Ansible/KNX/DPT10.html">Ansible::KNX::DPT10</a>
+
+    <li><a href="../Ansible/KNX/DPT10/DPT10_Frame.html">Ansible::KNX::DPT10::DPT10_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT11.html">Ansible::KNX::DPT11</a>
+
+    <li><a href="../Ansible/KNX/DPT11/DPT11_Frame.html">Ansible::KNX::DPT11::DPT11_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT12.html">Ansible::KNX::DPT12</a>
+
+    <li><a href="../Ansible/KNX/DPT12/DPT12_Frame.html">Ansible::KNX::DPT12::DPT12_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT13.html">Ansible::KNX::DPT13</a>
+
+    <li><a href="../Ansible/KNX/DPT13/DPT13_Frame.html">Ansible::KNX::DPT13::DPT13_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT14.html">Ansible::KNX::DPT14</a>
+
+    <li><a href="../Ansible/KNX/DPT14/DPT14_Float.html">Ansible::KNX::DPT14::DPT14_Float</a>
+
+    <li><a href="../Ansible/KNX/DPT14/DPT14_Frame.html">Ansible::KNX::DPT14::DPT14_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT15.html">Ansible::KNX::DPT15</a>
+
+    <li><a href="../Ansible/KNX/DPT15/DPT15_Frame.html">Ansible::KNX::DPT15::DPT15_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT16.html">Ansible::KNX::DPT16</a>
+
+    <li><a href="../Ansible/KNX/DPT16/DPT16_Frame.html">Ansible::KNX::DPT16::DPT16_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT17.html">Ansible::KNX::DPT17</a>
+
+    <li><a href="../Ansible/KNX/DPT17/DPT17_Frame.html">Ansible::KNX::DPT17::DPT17_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT18.html">Ansible::KNX::DPT18</a>
+
+    <li><a href="../Ansible/KNX/DPT18/DPT18_Frame.html">Ansible::KNX::DPT18::DPT18_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT19.html">Ansible::KNX::DPT19</a>
+
+    <li><a href="../Ansible/KNX/DPT19/DPT19_Frame.html">Ansible::KNX::DPT19::DPT19_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT1/DPT1_Frame.html">Ansible::KNX::DPT1::DPT1_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT2.html">Ansible::KNX::DPT2</a>
+
+    <li><a href="../Ansible/KNX/DPT2/DPT2_Frame.html">Ansible::KNX::DPT2::DPT2_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT3.html">Ansible::KNX::DPT3</a>
+
+    <li><a href="../Ansible/KNX/DPT3/DPT3_Frame.html">Ansible::KNX::DPT3::DPT3_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT4.html">Ansible::KNX::DPT4</a>
+
+    <li><a href="../Ansible/KNX/DPT4/DPT4_Frame.html">Ansible::KNX::DPT4::DPT4_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT5.html">Ansible::KNX::DPT5</a>
+
+    <li><a href="../Ansible/KNX/DPT5/DPT5_Frame.html">Ansible::KNX::DPT5::DPT5_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT6.html">Ansible::KNX::DPT6</a>
+
+    <li><a href="../Ansible/KNX/DPT6/DPT6_Frame.html">Ansible::KNX::DPT6::DPT6_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT7.html">Ansible::KNX::DPT7</a>
+
+    <li><a href="../Ansible/KNX/DPT7/DPT7_Frame.html">Ansible::KNX::DPT7::DPT7_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT8.html">Ansible::KNX::DPT8</a>
+
+    <li><a href="../Ansible/KNX/DPT8/DPT8_Frame.html">Ansible::KNX::DPT8::DPT8_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPT9.html">Ansible::KNX::DPT9</a>
+
+    <li><a href="../Ansible/KNX/DPT9/DPT9_Float.html">Ansible::KNX::DPT9::DPT9_Float</a>
+
+    <li><a href="../Ansible/KNX/DPT9/DPT9_Frame.html">Ansible::KNX::DPT9::DPT9_Frame</a>
+
+    <li><a href="../Ansible/KNX/DPTFrame.html">Ansible::KNX::DPTFrame</a>
+
+    <li><a href="../Ansible/KNX/EISType.html">Ansible::KNX::EISType</a>
+
+    <li><a href="../Ansible/KNX/KNXValue.html">Ansible::KNX::KNXValue</a>
+
+    <li><a href="../Ansible/KNX/KNX_Transceiver.html">Ansible::KNX::KNX_Transceiver</a>
+
+    <li><a href="../Ansible/KNX/KNX_Transceiver/NormalExit.html">Ansible::KNX::KNX_Transceiver::NormalExit</a>
+
+    <li><a href="../Ansible/KNX/L_DATA_Frame.html">Ansible::KNX::L_DATA_Frame</a>
+
+    <li><a href="../Ansible/KNX/ScalarValue.html">Ansible::KNX::ScalarValue</a>
+
+    <li><a href="../Ansible/KNX/Scene.html">Ansible::KNX::Scene</a>
+
+    <li><a href="../Ansible/KNX/TP_ControlField.html">Ansible::KNX::TP_ControlField</a>
+
+    <li><a href="../Ansible/Switch.html">Ansible::Switch</a>
+
+    <li><a href="../Ansible/Transceiver.html">Ansible::Transceiver</a>
+
+    <li><a href="../Ansible/ZWave.html">Ansible::ZWave</a>
+
+    <li><a href="../Ansible/ZWave/ValueID.html">Ansible::ZWave::ValueID</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_Bool.html">Ansible::ZWave::ValueType_Bool</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_Button.html">Ansible::ZWave::ValueType_Button</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_Byte.html">Ansible::ZWave::ValueType_Byte</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_Decimal.html">Ansible::ZWave::ValueType_Decimal</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_Int.html">Ansible::ZWave::ValueType_Int</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_List.html">Ansible::ZWave::ValueType_List</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_Short.html">Ansible::ZWave::ValueType_Short</a>
+
+    <li><a href="../Ansible/ZWave/ValueType_String.html">Ansible::ZWave::ValueType_String</a>
+
+    <li><a href="../Ansible/ZWave/ZWave_Transceiver.html">Ansible::ZWave::ZWave_Transceiver</a>
+
+    <li><a href="../DPT10.html">DPT10</a>
+
+    <li><a href="../DPT9.html">DPT9</a>
+
+    <li><a href="../DPT9_Float.html">DPT9_Float</a>
+
+    <li><a href="../EIBAddr.html">EIBAddr</a>
+
+    <li><a href="../EIBBuffer.html">EIBBuffer</a>
+
+    <li><a href="../EIBConnection.html">EIBConnection</a>
+
+    <li><a href="../EIBInt16.html">EIBInt16</a>
+
+    <li><a href="../EIBInt32.html">EIBInt32</a>
+
+    <li><a href="../EIBInt8.html">EIBInt8</a>
+
+    <li><a href="../OZW_ValueID_id.html">OZW_ValueID_id</a>
+
+    <li><a href="../OZW_ValueID_id1.html">OZW_ValueID_id1</a>
+
+    <li><a href="../Object.html">Object</a>
+
+    <li><a href="../OpenZWave.html">OpenZWave</a>
+
+    <li><a href="../OrbiterProxy.html">OrbiterProxy</a>
+
+    <li><a href="../String.html">String</a>
+
+    <li><a href="../Test.html">Test</a>
+
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="class">class Ansible::AbstractDevice</h1>
+
+  <div id="description" class="description">
+
+  </div><!-- description -->
+
+
+
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+
+
+
+    <!-- Methods -->
+
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+
+
+      <div id="method-c-new" class="method-detail ">
+
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(state_value)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+
+
+        <div class="method-description">
+
+
+
+
+
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File ansible_device.rb, line 90</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">state_value</span>)
+    <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;add_status: #{value} must be an AnsibleValue!&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">AnsibleValue</span>
+    <span class="ruby-ivar">@state_value</span> = <span class="ruby-identifier">state_value</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- new-source -->
+
+        </div>
+
+
+
+
+      </div><!-- new-method -->
+
+
+    </section><!-- public-class-method-details -->
+
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+