doc/TermUtils/FF/Config.html in term_utils-0.3.2 vs doc/TermUtils/FF/Config.html in term_utils-0.4.0
- old
+ new
@@ -4,19 +4,19 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: TermUtils::FF::Config
- — Documentation by YARD 0.9.20
+ — Documentation by YARD 0.9.25
</title>
- <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
- <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
pathId = "TermUtils::FF::Config";
relpath = '../../';
</script>
@@ -143,11 +143,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong> ⇒ Integer </a>
+ <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong> ⇒ Integer<sup>?</sup> </a>
</span>
@@ -168,11 +168,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong> ⇒ Integer </a>
+ <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong> ⇒ Integer<sup>?</sup> </a>
</span>
@@ -193,11 +193,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#sorted-instance_method" title="#sorted (instance method)">#<strong>sorted</strong> ⇒ Boolean </a>
+ <a href="#sorting_compare-instance_method" title="#sorting_compare (instance method)">#<strong>sorting_compare</strong> ⇒ Proc<sup>?</sup> </a>
</span>
@@ -215,10 +215,37 @@
<span class="summary_desc"><div class='inline'></div></span>
</li>
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#sorting_mode-instance_method" title="#sorting_mode (instance method)">#<strong>sorting_mode</strong> ⇒ Symbol<sup>?</sup> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'>
+<p>Either `:forward`, `:reverse` or `nil` (default).</p>
+</div></span>
+
+</li>
+
+
</ul>
@@ -248,11 +275,11 @@
<span class="summary_desc"><div class='inline'>
-<p>A new instance of Config.</p>
+<p>Constructs a new Config.</p>
</div></span>
</li>
@@ -276,10 +303,34 @@
<span class="summary_desc"><div class='inline'></div></span>
</li>
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#sorted%3F-instance_method" title="#sorted? (instance method)">#<strong>sorted?</strong> ⇒ Boolean </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'>
+<p>Returns whether the search is ordered.</p>
+</div></span>
+
+</li>
+
+
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
@@ -294,11 +345,11 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns a new instance of Config</p>
+<p>Constructs a new Config.</p>
</div>
</div>
<div class="tags">
@@ -308,25 +359,27 @@
<tr>
<td>
<pre class="lines">
-31
-32
-33
-34
35
-36</pre>
+36
+37
+38
+39
+40
+41</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 31</span>
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@ignore_list</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@min_depth</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@max_depth</span> <span class='op'>=</span> <span class='kw'>nil</span>
- <span class='ivar'>@sorted</span> <span class='op'>=</span> <span class='kw'>false</span>
+ <span class='ivar'>@sorting_mode</span> <span class='op'>=</span> <span class='kw'>nil</span>
+ <span class='ivar'>@sorting_compare</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -393,11 +446,11 @@
<span id="max_depth=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="max_depth-instance_method">
- #<strong>max_depth</strong> ⇒ <tt>Integer</tt>
+ #<strong>max_depth</strong> ⇒ <tt>Integer</tt><sup>?</sup>
@@ -413,11 +466,11 @@
<ul class="return">
<li>
- <span class='type'>(<tt>Integer</tt>)</span>
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
</li>
@@ -447,11 +500,11 @@
<span id="min_depth=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="min_depth-instance_method">
- #<strong>min_depth</strong> ⇒ <tt>Integer</tt>
+ #<strong>min_depth</strong> ⇒ <tt>Integer</tt><sup>?</sup>
@@ -467,11 +520,11 @@
<ul class="return">
<li>
- <span class='type'>(<tt>Integer</tt>)</span>
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
</li>
@@ -497,15 +550,15 @@
</tr>
</table>
</div>
- <span id="sorted=-instance_method"></span>
+ <span id="sorting_compare=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="sorted-instance_method">
+ <h3 class="signature " id="sorting_compare-instance_method">
- #<strong>sorted</strong> ⇒ <tt>Boolean</tt>
+ #<strong>sorting_compare</strong> ⇒ <tt>Proc</tt><sup>?</sup>
@@ -521,11 +574,11 @@
<ul class="return">
<li>
- <span class='type'>(<tt>Boolean</tt>)</span>
+ <span class='type'>(<tt>Proc</tt>, <tt>nil</tt>)</span>
</li>
@@ -535,19 +588,80 @@
<tr>
<td>
<pre class="lines">
+32
+33
+34</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 32</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_sorting_compare'>sorting_compare</span>
+ <span class='ivar'>@sorting_compare</span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+
+ <span id="sorting_mode=-instance_method"></span>
+ <div class="method_details ">
+ <h3 class="signature " id="sorting_mode-instance_method">
+
+ #<strong>sorting_mode</strong> ⇒ <tt>Symbol</tt><sup>?</sup>
+
+
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>Returns Either `:forward`, `:reverse` or `nil` (default).</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Symbol</tt>, <tt>nil</tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>Either `:forward`, `:reverse` or `nil` (default).</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 30</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_sorted'>sorted</span>
- <span class='ivar'>@sorted</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_sorting_mode'>sorting_mode</span>
+ <span class='ivar'>@sorting_mode</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -572,34 +686,88 @@
<tr>
<td>
<pre class="lines">
-37
-38
-39
-40</pre>
+49
+50
+51
+52</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 37</span>
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize_copy'>initialize_copy</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='ivar'>@ignore_list</span> <span class='op'>=</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_ignore_list'>ignore_list</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='kw'>super</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
+ <div class="method_details ">
+ <h3 class="signature " id="sorted?-instance_method">
+
+ #<strong>sorted?</strong> ⇒ <tt>Boolean</tt>
+
+
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>Returns whether the search is ordered.</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">
+
+
+45
+46
+47</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/term_utils/ff/config.rb', line 45</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_sorted?'>sorted?</span>
+ <span class='lparen'>(</span><span class='ivar'>@sorting_mode</span> <span class='op'>==</span> <span class='symbol'>:forward</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='ivar'>@sorting_mode</span> <span class='op'>==</span> <span class='symbol'>:reverse</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
</div>
+
+ </div>
+</div>
+
<div id="footer">
- Generated on Fri Feb 7 18:54:40 2020 by
+ Generated on Sun Aug 2 18:35:10 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.9.20 (ruby-2.6.5).
+ 0.9.25 (ruby-2.6.5).
</div>
</div>
</body>
</html>
\ No newline at end of file