doc/Contentful/BaseCoercion.html in contentful-2.12.0 vs doc/Contentful/BaseCoercion.html in contentful-2.13.0

- old
+ new

@@ -1,445 +1,445 @@ -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - Class: Contentful::BaseCoercion - - &mdash; Documentation by YARD 0.9.18 - -</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"> - pathId = "Contentful::BaseCoercion"; - relpath = '../'; -</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 class="nav_wrap"> - <iframe id="nav" src="../class_list.html?1"></iframe> - <div id="resizer"></div> - </div> - - <div id="main" tabindex="-1"> - <div id="header"> - <div id="menu"> - - <a href="../_index.html">Index (B)</a> &raquo; - <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span> - &raquo; - <span class="title">BaseCoercion</span> - -</div> - - <div id="search"> - - <a class="full_list_link" id="class_list_link" - href="../class_list.html"> - - <svg width="24" height="24"> - <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> - <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> - <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> - </svg> - </a> - -</div> - <div class="clear"></div> - </div> - - <div id="content"><h1>Class: Contentful::BaseCoercion - - - -</h1> -<div class="box_info"> - - <dl> - <dt>Inherits:</dt> - <dd> - <span class="inheritName">Object</span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next">Contentful::BaseCoercion</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - </dl> - - - - - - - - - - - - <dl> - <dt>Defined in:</dt> - <dd>lib/contentful/coercions.rb</dd> - </dl> - -</div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title> + Class: Contentful::BaseCoercion + + &mdash; Documentation by YARD 0.9.19 + +</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"> + pathId = "Contentful::BaseCoercion"; + relpath = '../'; +</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 class="nav_wrap"> + <iframe id="nav" src="../class_list.html?1"></iframe> + <div id="resizer"></div> + </div> + + <div id="main" tabindex="-1"> + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (B)</a> &raquo; + <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span> + &raquo; + <span class="title">BaseCoercion</span> + +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="../class_list.html"> + + <svg width="24" height="24"> + <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> + </svg> + </a> + +</div> + <div class="clear"></div> + </div> + + <div id="content"><h1>Class: Contentful::BaseCoercion + + + +</h1> +<div class="box_info"> + + <dl> + <dt>Inherits:</dt> + <dd> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Contentful::BaseCoercion</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + </dl> + + + + + + + + + + + + <dl> + <dt>Defined in:</dt> + <dd>lib/contentful/coercions.rb</dd> + </dl> + +</div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> <p>Basic Coercion</p> - - - </div> -</div> -<div class="tags"> - - -</div><div id="subclasses"> - <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="ArrayCoercion.html" title="Contentful::ArrayCoercion (class)">ArrayCoercion</a></span>, <span class='object_link'><a href="BooleanCoercion.html" title="Contentful::BooleanCoercion (class)">BooleanCoercion</a></span>, <span class='object_link'><a href="DateCoercion.html" title="Contentful::DateCoercion (class)">DateCoercion</a></span>, <span class='object_link'><a href="FloatCoercion.html" title="Contentful::FloatCoercion (class)">FloatCoercion</a></span>, <span class='object_link'><a href="IntegerCoercion.html" title="Contentful::IntegerCoercion (class)">IntegerCoercion</a></span>, <span class='object_link'><a href="LinkCoercion.html" title="Contentful::LinkCoercion (class)">LinkCoercion</a></span>, <span class='object_link'><a href="LocationCoercion.html" title="Contentful::LocationCoercion (class)">LocationCoercion</a></span>, <span class='object_link'><a href="ObjectCoercion.html" title="Contentful::ObjectCoercion (class)">ObjectCoercion</a></span>, <span class='object_link'><a href="RichTextCoercion.html" title="Contentful::RichTextCoercion (class)">RichTextCoercion</a></span>, <span class='object_link'><a href="StringCoercion.html" title="Contentful::StringCoercion (class)">StringCoercion</a></span></p> -</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="#options-instance_method" title="#options (instance method)">#<strong>options</strong> &#x21d2; Object </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - + + + </div> +</div> +<div class="tags"> + + +</div><div id="subclasses"> + <h2>Direct Known Subclasses</h2> + <p class="children"><span class='object_link'><a href="ArrayCoercion.html" title="Contentful::ArrayCoercion (class)">ArrayCoercion</a></span>, <span class='object_link'><a href="BooleanCoercion.html" title="Contentful::BooleanCoercion (class)">BooleanCoercion</a></span>, <span class='object_link'><a href="DateCoercion.html" title="Contentful::DateCoercion (class)">DateCoercion</a></span>, <span class='object_link'><a href="FloatCoercion.html" title="Contentful::FloatCoercion (class)">FloatCoercion</a></span>, <span class='object_link'><a href="IntegerCoercion.html" title="Contentful::IntegerCoercion (class)">IntegerCoercion</a></span>, <span class='object_link'><a href="LinkCoercion.html" title="Contentful::LinkCoercion (class)">LinkCoercion</a></span>, <span class='object_link'><a href="LocationCoercion.html" title="Contentful::LocationCoercion (class)">LocationCoercion</a></span>, <span class='object_link'><a href="ObjectCoercion.html" title="Contentful::ObjectCoercion (class)">ObjectCoercion</a></span>, <span class='object_link'><a href="RichTextCoercion.html" title="Contentful::RichTextCoercion (class)">RichTextCoercion</a></span>, <span class='object_link'><a href="StringCoercion.html" title="Contentful::StringCoercion (class)">StringCoercion</a></span></p> +</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="#options-instance_method" title="#options (instance method)">#<strong>options</strong> &#x21d2; Object </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute options.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> &#x21d2; Object </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> &#x21d2; Object </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Returns the value of attribute value.</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="#coerce-instance_method" title="#coerce (instance method)">#<strong>coerce</strong> &#x21d2; Object </a> - - - - </span> - - - - - - - - - +</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="#coerce-instance_method" title="#coerce (instance method)">#<strong>coerce</strong> &#x21d2; Object </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>Coerces value.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value, options = {}) &#x21d2; BaseCoercion </a> - - - - </span> - - - <span class="note title constructor">constructor</span> - - - - - - - - +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(value, options = {}) &#x21d2; BaseCoercion </a> + + + + </span> + + + <span class="note title constructor">constructor</span> + + + + + + + + <span class="summary_desc"><div class='inline'> <p>A new instance of BaseCoercion.</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"> - - #<strong>initialize</strong>(value, options = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::BaseCoercion (class)">BaseCoercion</a></span></tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> +</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"> + + #<strong>initialize</strong>(value, options = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Contentful::BaseCoercion (class)">BaseCoercion</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> <p>Returns a new instance of BaseCoercion</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 8 9 10 -11</pre> - </td> - <td> +11</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/coercions.rb', line 8</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span> <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</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=""></span> - <div class="method_details first"> - <h3 class="signature first" id="options-instance_method"> - - #<strong>options</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span> - - - - - -</h3><div class="docstring"> - <div class="discussion"> +<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=""></span> + <div class="method_details first"> + <h3 class="signature first" id="options-instance_method"> + + #<strong>options</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p>Returns the value of attribute options</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 7 8 -9</pre> - </td> - <td> +9</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/coercions.rb', line 7</span> <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span> <span class='ivar'>@options</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <div class="method_details "> - <h3 class="signature " id="value-instance_method"> - - #<strong>value</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span> - - - - - -</h3><div class="docstring"> - <div class="discussion"> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="value-instance_method"> + + #<strong>value</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p>Returns the value of attribute value</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 7 8 -9</pre> - </td> - <td> +9</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/coercions.rb', line 7</span> <span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span> <span class='ivar'>@value</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - - - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - - - <div class="method_details first"> - <h3 class="signature first" id="coerce-instance_method"> - - #<strong>coerce</strong> &#x21d2; <tt>Object</tt> - - - - - -</h3><div class="docstring"> - <div class="discussion"> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + </div> + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="coerce-instance_method"> + + #<strong>coerce</strong> &#x21d2; <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p>Coerces value</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> <pre class="lines"> 14 15 -16</pre> - </td> - <td> +16</pre> + </td> + <td> <pre class="code"><span class="info file"># File 'lib/contentful/coercions.rb', line 14</span> <span class='kw'>def</span> <span class='id identifier rubyid_coerce'>coerce</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span> <span class='id identifier rubyid_value'>value</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Tue Apr 9 10:49:56 2019 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.18 (ruby-2.5.3). -</div> - - </div> - </body> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Wed Jun 26 15:30:22 2019 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.19 (ruby-2.6.1). +</div> + + </div> + </body> </html> \ No newline at end of file