doc/TermUtils/FF.html in term_utils-0.4.0 vs doc/TermUtils/FF.html in term_utils-0.5.0

- old
+ new

@@ -4,11 +4,11 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Module: TermUtils::FF - &mdash; Documentation by YARD 0.9.25 + &mdash; Documentation by YARD 0.9.34 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" /> @@ -77,20 +77,20 @@ <dl> <dt>Defined in:</dt> <dd>lib/term_utils/ff.rb<span class="defines">,<br /> - lib/term_utils/ff/entry.rb,<br /> lib/term_utils/ff/query.rb,<br /> lib/term_utils/ff/config.rb</span> + lib/term_utils/ff/entry.rb,<br /> lib/term_utils/ff/query.rb,<br /> lib/term_utils/ff/config.rb,<br /> lib/term_utils/ff/finder.rb</span> </dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Provides a way to find files.</p> +<p>Provides ways to find files.</p> </div> </div> <div class="tags"> @@ -100,28 +100,152 @@ <p class="children"> - <strong class="classes">Classes:</strong> <span class='object_link'><a href="FF/Config.html" title="TermUtils::FF::Config (class)">Config</a></span>, <span class='object_link'><a href="FF/Context.html" title="TermUtils::FF::Context (class)">Context</a></span>, <span class='object_link'><a href="FF/Entry.html" title="TermUtils::FF::Entry (class)">Entry</a></span>, <span class='object_link'><a href="FF/Query.html" title="TermUtils::FF::Query (class)">Query</a></span> + <strong class="classes">Classes:</strong> <span class='object_link'><a href="FF/Config.html" title="TermUtils::FF::Config (class)">Config</a></span>, <span class='object_link'><a href="FF/Context.html" title="TermUtils::FF::Context (class)">Context</a></span>, <span class='object_link'><a href="FF/Entry.html" title="TermUtils::FF::Entry (class)">Entry</a></span>, <span class='object_link'><a href="FF/Finder.html" title="TermUtils::FF::Finder (class)">Finder</a></span>, <span class='object_link'><a href="FF/FinderEntry.html" title="TermUtils::FF::FinderEntry (class)">FinderEntry</a></span>, <span class='object_link'><a href="FF/FinderQuery.html" title="TermUtils::FF::FinderQuery (class)">FinderQuery</a></span>, <span class='object_link'><a href="FF/Query.html" title="TermUtils::FF::Query (class)">Query</a></span> </p> + + <h2> + Class Method Summary + <small><a href="#" class="summary_toggle">collapse</a></small> + </h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(*paths, &amp;block) &#x21d2; Array&lt;Hash&gt; </a> + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Finds files.</p> +</div></span> + +</li> + + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <h3 class="signature first" id="find-class_method"> + + .<strong>find</strong>(*paths, &amp;block) &#x21d2; <tt>Array&lt;Hash&gt;</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Finds files.</p> + + + </div> </div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>paths</span> + + + <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span> + + + + </li> + +</ul> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +244 +245 +246 +247 +248 +249 +250 +251 +252 +253</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/term_utils/ff/finder.rb', line 244</span> + +<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span> + <span class='id identifier rubyid_fdr'>fdr</span> <span class='op'>=</span> + <span class='kw'>if</span> <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> + <span class='const'><span class='object_link'><a href="../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FF/Finder.html" title="TermUtils::FF::Finder (class)">Finder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FF/Finder.html#initialize-instance_method" title="TermUtils::FF::Finder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span> + <span class='kw'>else</span> + <span class='const'><span class='object_link'><a href="../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FF/Finder.html" title="TermUtils::FF::Finder (class)">Finder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FF/Finder.html#initialize-instance_method" title="TermUtils::FF::Finder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span> + <span class='kw'>end</span> + <span class='id identifier rubyid_block'>block</span><span class='op'>&amp;.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_fdr'>fdr</span><span class='period'>.</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span> + <span class='id identifier rubyid_fdr'>fdr</span><span class='period'>.</span><span class='id identifier rubyid_exec'>exec</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + <div id="footer"> - Generated on Sun Aug 2 18:35:09 2020 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.25 (ruby-2.6.5). + Generated on Wed Aug 9 17:34:25 2023 by + <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.34 (ruby-3.2.2). </div> </div> </body> </html> \ No newline at end of file