<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Doing::Note
— Documentation by YARD 0.9.37
</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::Note";
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 (N)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">Note</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::Note
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Array.html" title="Array (class)">Array</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"><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></li>
<li class="next">Doing::Note</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/note.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class describes an item note.</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="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(note, replace: false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add note contents, optionally replacing existing note.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compress-instance_method" title="#compress (instance method)">#<strong>compress</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Remove blank lines and comments (#).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compress!-instance_method" title="#compress! (instance method)">#<strong>compress!</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#equal%3F-instance_method" title="#equal? (instance method)">#<strong>equal?</strong>(other) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if a note is equal (compare string representations).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(note = []) ⇒ Note </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initializes a new note.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#strip_lines-instance_method" title="#strip_lines (instance method)">#<strong>strip_lines</strong> ⇒ Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Remove leading/trailing whitespace for every line of note.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#strip_lines!-instance_method" title="#strip_lines! (instance method)">#<strong>strip_lines!</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_line-instance_method" title="#to_line (instance method)">#<strong>to_line</strong>(separator: ' ') ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns note as a single line, newlines separated by space.</p>
</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>(prefix: "\t\t") ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Note as multi-line string.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Array.html#cap_first-instance_method" title="Array#cap_first (method)">#cap_first</a></span>, <span class='object_link'><a href="../Array.html#good%3F-instance_method" title="Array#good? (method)">#good?</a></span>, <span class='object_link'><a href="../Array.html#utf8-instance_method" title="Array#utf8 (method)">#utf8</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="ChronifyArray.html" title="Doing::ChronifyArray (module)">ChronifyArray</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ChronifyArray.html#time_string-instance_method" title="Doing::ChronifyArray#time_string (method)">#time_string</a></span>, <span class='object_link'><a href="ChronifyArray.html#to_abbr-instance_method" title="Doing::ChronifyArray#to_abbr (method)">#to_abbr</a></span>, <span class='object_link'><a href="ChronifyArray.html#to_natural-instance_method" title="Doing::ChronifyArray#to_natural (method)">#to_natural</a></span>, <span class='object_link'><a href="ChronifyArray.html#to_years-instance_method" title="Doing::ChronifyArray#to_years (method)">#to_years</a></span></p>
<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>(note = []) ⇒ <tt><span class='object_link'><a href="" title="Doing::Note (class)">Note</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes a new note</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>note</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
—
<div class='inline'><p>Initial note, can be string
or array</p>
</div>
</li>
</ul>
</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="add-instance_method">
#<strong>add</strong>(note, replace: false) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add note contents, optionally replacing existing note</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>note</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>|<span class='object_link'><a href="../String.html" title="String (class)">String</a></span>|<span class='object_link'><a href="" title="Doing::Note (class)">Note</a></span></tt>)</span>
—
<div class='inline'><p>The note to add, can be
String, Array, or Note</p>
</div>
</li>
<li>
<span class='name'>replace</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>replace existing
content</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="compress-instance_method">
#<strong>compress</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Remove blank lines and comments (#)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>compressed array</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="compress!-instance_method">
#<strong>compress!</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="equal?-instance_method">
#<strong>equal?</strong>(other) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if a note is equal (compare string
representations)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>other</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Note (class)">Note</a></span></tt>)</span>
—
<div class='inline'><p>The other Note</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if equal</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="strip_lines-instance_method">
#<strong>strip_lines</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Remove leading/trailing whitespace for
every line of note</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>Stripped note</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="strip_lines!-instance_method">
#<strong>strip_lines!</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_line-instance_method">
#<strong>to_line</strong>(separator: ' ') ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns note as a single line, newlines separated by
space</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>separator</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>' '</tt>)</em>
—
<div class='inline'><p>The separator with which to
join multiple lines</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>Line representation of the Note.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong>(prefix: "\t\t") ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Note as multi-line string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>prefix</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>"\t\t"</tt>)</em>
—
<div class='inline'><p>prefix for each line (default two tabs, TaskPaper format)</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Dec 14 15:35:59 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.0).
</div>
</div>
</body>
</html>