<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Doing::Change — Documentation by YARD 0.9.28 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> <link rel="stylesheet" href="../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "Doing::Change"; 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 (C)</a> » <span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span> » <span class="title">Change</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: Doing::Change </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></span> <ul class="fullTree"> <li><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></li> <li class="next">Doing::Change</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/doing/changelog/change.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>A single version's entries</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="#change_date-instance_method" title="#change_date (instance method)">#<strong>change_date</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute change_date.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> ⇒ Object </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute content.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute entries.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#prefix=-instance_method" title="#prefix= (instance method)">#<strong>prefix</strong> ⇒ Object </a> </span> <span class="note title writeonly">writeonly</span> <span class="summary_desc"><div class='inline'><p>Sets the attribute prefix.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#version-instance_method" title="#version (instance method)">#<strong>version</strong> ⇒ Object </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute version.</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="#changes_only-instance_method" title="#changes_only (instance method)">#<strong>changes_only</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(version, content, prefix: false, only: %i[changed new improved fixed]) ⇒ Change </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of Change.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#parse_entries-instance_method" title="#parse_entries (instance method)">#<strong>parse_entries</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#search_entries-instance_method" title="#search_entries (instance method)">#<strong>search_entries</strong>(search_string) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#split_items-instance_method" title="#split_items (instance method)">#<strong>split_items</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></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>(version, content, prefix: false, only: %i[changed new improved fixed]) ⇒ <tt><span class='object_link'><a href="" title="Doing::Change (class)">Change</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Change.</p> </div> </div> <div class="tags"> </div> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="change_date=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="change_date-instance_method"> #<strong>change_date</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute change_date.</p> </div> </div> <div class="tags"> </div> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="content-instance_method"> #<strong>content</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute content.</p> </div> </div> <div class="tags"> </div> </div> <span id="entries=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="entries-instance_method"> #<strong>entries</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute entries.</p> </div> </div> <div class="tags"> </div> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="prefix=-instance_method"> #<strong>prefix=</strong>(value) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(writeonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Sets the attribute prefix</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>value</span> <span class='type'></span> — <div class='inline'><p>the value to set the attribute prefix to.</p> </div> </li> </ul> </div> </div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="version-instance_method"> #<strong>version</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute version.</p> </div> </div> <div class="tags"> </div> </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="changes_only-instance_method"> #<strong>changes_only</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="parse_entries-instance_method"> #<strong>parse_entries</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="search_entries-instance_method"> #<strong>search_entries</strong>(search_string) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="split_items-instance_method"> #<strong>split_items</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="to_h-instance_method"> #<strong>to_h</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> <div class="method_details "> <h3 class="signature " id="to_s-instance_method"> #<strong>to_s</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt> </h3> </div> </div> </div> <div id="footer"> Generated on Sat Mar 11 06:08:18 2023 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.28 (ruby-3.0.1). </div> </div> </body> </html>