doc/DirTravel/Travel.html in dirtravel-0.0.6 vs doc/DirTravel/Travel.html in dirtravel-0.0.7
- old
+ new
@@ -1,117 +1,114 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html>
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: DirTravel::Travel
- — Documentation by YARD 0.8.7.6
+ — Documentation by YARD 0.9.36
</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">
- hasFrames = window.top.frames.main ? true : false;
+<script type="text/javascript">
+ pathId = "DirTravel::Travel";
relpath = '../';
- framesUrl = "../frames.html#!DirTravel/Travel.html";
</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 id="header">
- <div id="menu">
+ <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 (T)</a> »
<span class='title'><span class='object_link'><a href="../DirTravel.html" title="DirTravel (module)">DirTravel</a></span></span>
»
<span class="title">Travel</span>
-
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
- <div id="search">
+ <div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
- Class List
+
+ <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>
- <a class="full_list_link" id="method_list_link"
- href="../method_list.html">
- Method List
- </a>
-
- <a class="full_list_link" id="file_list_link"
- href="../file_list.html">
- File List
- </a>
-
</div>
- <div class="clear"></div>
- </div>
+ <div class="clear"></div>
+ </div>
- <iframe id="search_frame"></iframe>
-
- <div id="content"><h1>Class: DirTravel::Travel
+ <div id="content"><h1>Class: DirTravel::Travel
</h1>
-
-<dl class="box">
+<div class="box_info">
- <dt class="r1">Inherits:</dt>
- <dd class="r1">
+ <dl>
+ <dt>Inherits:</dt>
+ <dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">DirTravel::Travel</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
- </dd>
-
+ </dd>
+ </dl>
+
-
-
- <dt class="r2 last">Defined in:</dt>
- <dd class="r2 last">lib/dirtravel.rb</dd>
+
-</dl>
-<div class="clear"></div>
+
+ <dl>
+ <dt>Defined in:</dt>
+ <dd>lib/dirtravel.rb</dd>
+ </dl>
+
+</div>
+
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-<p>Create directory recursion tree (with <span class='object_link'><a href="#filetree-class_method" title="DirTravel::Travel.filetree (method)">Travel.filetree</a></span>). Optionally filter
-with suffix and modify tree building with options Hash (see below).</p>
+<p>Create directory recursion tree (with <span class='object_link'><a href="#filetree-class_method" title="DirTravel::Travel.filetree (method)">Travel.filetree</a></span>). Optionally filter with suffix and modify tree building with options Hash (see below).</p>
-<p>If basedir is absolute path, the root name is the search path. If basedir
-is relative path, before search the current directory is changed to
-referenced directory and root name is the current directory, single level.</p>
+<p>If basedir is an absolute path, the root name is the search path. If basedir is a relative path, the current directory is changed to referenced directory before search and root name is the current directory, single level.</p>
-<h2 id="label-Parameters%3A">Parameters:</h2>
+<h2 id="label-Parameters-3A">Parameters:</h2>
<dl class="rdoc-list note-list"><dt>sort
<dd>
<p>Sort directory entries (default: false).</p>
</dd><dt>suffix
<dd>
@@ -124,11 +121,11 @@
<p>Basedirs parent becomes the basedir (default: false).</p>
</dd></dl>
<p>Example:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_d1'>d1</span> <span class='op'>=</span> <span class='const'>DirTravel</span><span class='op'>::</span><span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_dir1'>dir1</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:sort</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:suffix</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.mp3</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_d1'>d1</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DirTravel.html" title="DirTravel (module)">DirTravel</a></span></span><span class='op'>::</span><span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'><span class='object_link'><a href="#filetree-class_method" title="DirTravel::Travel.filetree (method)">filetree</a></span></span><span class='lparen'>(</span> <span class='id identifier rubyid_dir1'>dir1</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:sort</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:suffix</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.mp3</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='rparen'>)</span>
</code></pre>
</div>
</div>
@@ -137,17 +134,17 @@
</div>
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+ <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="#abspath-instance_method" title="#abspath (instance method)">- (Object) <strong>abspath</strong> </a>
+ <a href="#abspath-instance_method" title="#abspath (instance method)">#<strong>abspath</strong> ⇒ Object </a>
</span>
@@ -170,11 +167,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#basedir-instance_method" title="#basedir (instance method)">- (Object) <strong>basedir</strong> </a>
+ <a href="#basedir-instance_method" title="#basedir (instance method)">#<strong>basedir</strong> ⇒ Object </a>
</span>
@@ -197,11 +194,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#defaults-instance_method" title="#defaults (instance method)">- (Object) <strong>defaults</strong> </a>
+ <a href="#defaults-instance_method" title="#defaults (instance method)">#<strong>defaults</strong> ⇒ Object </a>
</span>
@@ -224,11 +221,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#root-instance_method" title="#root (instance method)">- (Object) <strong>root</strong> </a>
+ <a href="#root-instance_method" title="#root (instance method)">#<strong>root</strong> ⇒ Object </a>
</span>
@@ -256,19 +253,19 @@
<h2>
Class Method Summary
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ <small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#filetree-class_method" title="filetree (class method)">+ (DirEntry) <strong>filetree</strong>(basedir = '.', options = {}) </a>
+ <a href="#filetree-class_method" title="filetree (class method)">.<strong>filetree</strong>(basedir = '.', options = {}) ⇒ DirEntry </a>
</span>
@@ -289,19 +286,19 @@
</ul>
<h2>
Instance Method Summary
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ <small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Travel) <strong>initialize</strong>(basedir, abspath, options = {}) </a>
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(basedir, abspath, options = {}) ⇒ Travel </a>
</span>
@@ -323,11 +320,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#travel-instance_method" title="#travel (instance method)">- (Object) <strong>travel</strong>(suffix = @defaults[ :suffix ]) </a>
+ <a href="#travel-instance_method" title="#travel (instance method)">#<strong>travel</strong>(suffix = ) ⇒ Object </a>
</span>
@@ -353,21 +350,20 @@
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- - (<tt><span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span></tt>) <strong>initialize</strong>(basedir, abspath, options = {})
+ #<strong>initialize</strong>(basedir, abspath, options = {}) ⇒ <tt><span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
-<p>Create directory recursion object. Overlay options on top of defaults.
-Initialize root <span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span>.</p>
+<p>Create directory recursion object. Overlay options on top of defaults. Initialize root <span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span>.</p>
</div>
</div>
<div class="tags">
@@ -463,11 +459,11 @@
<span class='symbol'>:inclusive</span> <span class='op'>=></span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@defaults</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
- <span class='ivar'>@root</span> <span class='op'>=</span> <span class='const'>DirEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_abspath'>abspath</span> <span class='rparen'>)</span>
+ <span class='ivar'>@root</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DirEntry.html#initialize-instance_method" title="DirTravel::DirEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_abspath'>abspath</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -480,20 +476,20 @@
<span id="abspath=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="abspath-instance_method">
- - (<tt>Object</tt>) <strong>abspath</strong>
+ #<strong>abspath</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute abspath</p>
+<p>Returns the value of attribute abspath.</p>
</div>
</div>
<div class="tags">
@@ -523,11 +519,11 @@
<span id="basedir=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="basedir-instance_method">
- - (<tt>Object</tt>) <strong>basedir</strong>
+ #<strong>basedir</strong> ⇒ <tt>Object</tt>
@@ -566,11 +562,11 @@
<span id="defaults=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="defaults-instance_method">
- - (<tt>Object</tt>) <strong>defaults</strong>
+ #<strong>defaults</strong> ⇒ <tt>Object</tt>
@@ -609,11 +605,11 @@
<span id="root=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="root-instance_method">
- - (<tt>Object</tt>) <strong>root</strong>
+ #<strong>root</strong> ⇒ <tt>Object</tt>
@@ -639,11 +635,11 @@
227</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 225</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_root'><span class='object_link'><a href="../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span>
<span class='ivar'>@root</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
@@ -657,11 +653,11 @@
<div class="method_details first">
<h3 class="signature first" id="filetree-class_method">
- + (<tt><span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span></tt>) <strong>filetree</strong>(basedir = '.', options = {})
+ .<strong>filetree</strong>(basedir = '.', options = {}) ⇒ <tt><span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span></tt>
@@ -806,19 +802,19 @@
303</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 240</span>
-<span class='kw'>def</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></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='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></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='comment'># Non-nil if directory needs to be changed.
</span> <span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>if</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span>
<span class='comment'># Absolue path.
-</span> <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
+</span> <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DirTravel::Travel#initialize (method)">new</a></span></span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_travel'>travel</span>
<span class='kw'>else</span>
<span class='comment'># Relative path.
@@ -833,11 +829,11 @@
<span class='id identifier rubyid_dir'>dir</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span> <span class='id identifier rubyid_full'>full</span> <span class='rparen'>)</span>
<span class='comment'># Goto target.
</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span> <span class='id identifier rubyid_dir'>dir</span> <span class='rparen'>)</span>
- <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_base'>base</span><span class='comma'>,</span> <span class='id identifier rubyid_full'>full</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
+ <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DirTravel::Travel#initialize (method)">new</a></span></span><span class='lparen'>(</span> <span class='id identifier rubyid_base'>base</span><span class='comma'>,</span> <span class='id identifier rubyid_full'>full</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_travel'>travel</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_defaults'>defaults</span><span class='lbracket'>[</span> <span class='symbol'>:inclusive</span> <span class='rbracket'>]</span>
@@ -852,11 +848,11 @@
<span class='kw'>else</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_uppath'>uppath</span>
<span class='kw'>end</span>
<span class='comment'># Create the "one-up" root.
-</span> <span class='id identifier rubyid_newRoot'>newRoot</span> <span class='op'>=</span> <span class='const'>DirEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_uppath'>uppath</span> <span class='rparen'>)</span>
+</span> <span class='id identifier rubyid_newRoot'>newRoot</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DirEntry.html#initialize-instance_method" title="DirTravel::DirEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_uppath'>uppath</span> <span class='rparen'>)</span>
<span class='comment'># Rename old root.
</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_rename'>rename</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_tip'>tip</span> <span class='rparen'>)</span>
<span class='comment'># Add to one-up root.
@@ -884,11 +880,11 @@
<div class="method_details first">
<h3 class="signature first" id="travel-instance_method">
- - (<tt>Object</tt>) <strong>travel</strong>(suffix = @defaults[ :suffix ])
+ #<strong>travel</strong>(suffix = ) ⇒ <tt>Object</tt>
@@ -926,13 +922,14 @@
</div>
</div>
- <div id="footer">
- Generated on Sun Apr 19 15:01:50 2015 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.8.7.6 (ruby-2.1.2).
+ <div id="footer">
+ Generated on Fri Jun 28 14:38:02 2024 by
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.9.36 (ruby-3.1.2).
</div>
+ </div>
</body>
</html>
\ No newline at end of file