RubyGems - redsnow - Versions diffs - 0.3.1 → 0.3.2 - Mend

redsnow 0.3.1 → 0.3.2

Files changed (583) hide show

@@ -0,0 +1,295 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: RedSnow::Object
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/Object.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (O)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">Object</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: RedSnow::Object
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">RedSnow::Object</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/redsnow/object.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Class from MatterCompiler as ascendant</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#blank%3F-instance_method" title="#blank? (instance method)">- (Boolean) <strong>blank?</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns true if object is nil or empty, false otherwise.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#deep_symbolize_keys-instance_method" title="#deep_symbolize_keys (instance method)">- (Object) <strong>deep_symbolize_keys</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Symbolizes keys of a hash.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="blank?-instance_method">
+    - (<tt>Boolean</tt>) <strong>blank?</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns true if object is nil or empty, false otherwise</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/object.rb', line 14</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_blank?'>blank?</span>
+  <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:empty?</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>:</span> <span class='op'>!</span><span class='kw'>self</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="deep_symbolize_keys-instance_method">
+    - (<tt><span class='object_link'><a href="" title="RedSnow::Object (class)">Object</a></span></tt>) <strong>deep_symbolize_keys</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Symbolizes keys of a hash</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/object.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_deep_symbolize_keys'>deep_symbolize_keys</span>
+  <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_inject'>inject</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_memo'>memo</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span><span class='op'>|</span> <span class='id identifier rubyid_memo'>memo</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_deep_symbolize_keys'>deep_symbolize_keys</span><span class='semicolon'>;</span> <span class='id identifier rubyid_memo'>memo</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
+  <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_inject'>inject</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_memo'>memo</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span> <span class='op'>|</span> <span class='id identifier rubyid_memo'>memo</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_deep_symbolize_keys'>deep_symbolize_keys</span><span class='semicolon'>;</span> <span class='id identifier rubyid_memo'>memo</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Array</span>
+  <span class='kw'>return</span> <span class='kw'>self</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:32 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).
+</div>
+  </body>
+</html>

data/doc/RedSnow/Parameter.html ADDED

@@ -0,0 +1,881 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: RedSnow::Parameter
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/Parameter.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (P)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">Parameter</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: RedSnow::Parameter
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="NamedBlueprintNode.html" title="RedSnow::NamedBlueprintNode (class)">NamedBlueprintNode</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BlueprintNode.html" title="RedSnow::BlueprintNode (class)">BlueprintNode</a></span></li>
+            <li class="next"><span class='object_link'><a href="NamedBlueprintNode.html" title="RedSnow::NamedBlueprintNode (class)">NamedBlueprintNode</a></span></li>
+            <li class="next">RedSnow::Parameter</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/redsnow/blueprint.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>URI parameter Blueprint AST node  represents one &#39;parameters
+section&#39; parameter</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#default_value-instance_method" title="#default_value (instance method)">- (String) <strong>default_value</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>default value of the parameter or nil This is a value used when the
+parameter is ommited in the request.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#description-instance_method" title="#description (instance method)">- (String) <strong>description</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="NamedBlueprintNode.html#description-instance_method" title="RedSnow::NamedBlueprintNode#description (method)">NamedBlueprintNode</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>description of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#example_value-instance_method" title="#example_value (instance method)">- (String) <strong>example_value</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>example value of the parameter or nil.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="NamedBlueprintNode.html#name-instance_method" title="RedSnow::NamedBlueprintNode#name (method)">NamedBlueprintNode</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>name of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#type-instance_method" title="#type (instance method)">- (String) <strong>type</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>an arbitrary type of the parameter or nil.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#use-instance_method" title="#use (instance method)">- (Symbol) <strong>use</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>parameter necessity flag, <code>:required</code> or <code>:optional</code>.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#values-instance_method" title="#values (instance method)">- (Array&lt;String&gt;) <strong>values</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>an enumeration of possible parameter values.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Parameter) <strong>initialize</strong>(sc_parameter_handle) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Parameter.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="RedSnow::Parameter (class)">Parameter</a></span></tt>) <strong>initialize</strong>(sc_parameter_handle)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of Parameter</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>sc_parameter_handle</span>
+        <span class='type'>(<tt>FFI::Pointer</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+137
+138</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 120</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@name</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_parameter_name'>sc_parameter_name</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@description</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_parameter_description'>sc_parameter_description</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@type</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_parameter_type'>sc_parameter_type</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@use</span> <span class='op'>=</span>  <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_parameter_parameter_use'>sc_parameter_parameter_use</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@default_value</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_parameter_default_value'>sc_parameter_default_value</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@example_value</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_parameter_example_value'>sc_parameter_example_value</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@values</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_sc_value_collection_handle'>sc_value_collection_handle</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_value_collection_handle'>sc_value_collection_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_parameter_handle'>sc_parameter_handle</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_sc_value_collection_size'>sc_value_collection_size</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_value_collection_size'>sc_value_collection_size</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_value_collection_handle'>sc_value_collection_handle</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_sc_value_collection_size'>sc_value_collection_size</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_values_size'>values_size</span> <span class='op'>=</span> <span class='id identifier rubyid_sc_value_collection_size'>sc_value_collection_size</span> <span class='op'>-</span> <span class='int'>1</span>
+    <span class='kw'>for</span> <span class='id identifier rubyid_valueIndex'>valueIndex</span> <span class='kw'>in</span> <span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_values_size'>values_size</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_sc_value_handle'>sc_value_handle</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_value_handle'>sc_value_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_value_collection_handle'>sc_value_collection_handle</span><span class='comma'>,</span> <span class='id identifier rubyid_valueIndex'>valueIndex</span><span class='rparen'>)</span>
+      <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_value_string'>sc_value_string</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_value_handle'>sc_value_handle</span><span class='rparen'>)</span>
+      <span class='ivar'>@values</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_value'>value</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="default_value=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="default_value-instance_method">
+    - (<tt>String</tt>) <strong>default_value</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>default value of the parameter or nil This is a value used when the
+parameter is ommited in the request.</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of default_value</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+112
+113
+114</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 112</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_default_value'>default_value</span>
+  <span class='ivar'>@default_value</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="description=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="description-instance_method">
+    - (<tt>String</tt>) <strong>description</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="NamedBlueprintNode.html#description-instance_method" title="RedSnow::NamedBlueprintNode#description (method)">NamedBlueprintNode</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>description of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of description</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+      <span id="example_value=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="example_value-instance_method">
+    - (<tt>String</tt>) <strong>example_value</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>example value of the parameter or nil</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of example_value</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+112
+113
+114</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 112</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_example_value'>example_value</span>
+  <span class='ivar'>@example_value</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="name=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="NamedBlueprintNode.html#name-instance_method" title="RedSnow::NamedBlueprintNode#name (method)">NamedBlueprintNode</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>name of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of name</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+      <span id="type=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="type-instance_method">
+    - (<tt>String</tt>) <strong>type</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>an arbitrary type of the parameter or nil</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of type</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+112
+113
+114</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 112</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
+  <span class='ivar'>@type</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="use=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="use-instance_method">
+    - (<tt>Symbol</tt>) <strong>use</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>parameter necessity flag, <code>:required</code> or <code>:optional</code></p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Symbol</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of use</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+112
+113
+114</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 112</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_use'>use</span>
+  <span class='ivar'>@use</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="values=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="values-instance_method">
+    - (<tt>Array&lt;String&gt;</tt>) <strong>values</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>an enumeration of possible parameter values</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of values</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+112
+113
+114</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 112</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_values'>values</span>
+  <span class='ivar'>@values</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:33 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).
+</div>
+  </body>
+</html>