docs/Yk/ESet.html in YkESet-0.99.5 vs docs/Yk/ESet.html in YkESet-0.99.6
- old
+ new
@@ -136,11 +136,11 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(first, last, obj = nil) {|obj| ... } ⇒ ESet::Iterator </a>
+ <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(first, last, obj = nil) ⇒ Object </a>
</span>
@@ -150,13 +150,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Searches the container for an element with an object equivalent to the third argument and/or validated with the provided block in a range of elements ([first,last)), 'obj' and returns an iterator to it if found, otherwise it returns an iterator to .</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -265,11 +263,11 @@
<li class="public ">
<span class="summary_signature">
- <a href="#erase-instance_method" title="#erase (instance method)">#<strong>erase</strong>(first, last) ⇒ Object </a>
+ <a href="#erase-instance_method" title="#erase (instance method)">#<strong>erase</strong>(*args) ⇒ Object </a>
</span>
@@ -279,13 +277,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Removes from the set container a range of elements ([first,last)).</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -499,19 +495,92 @@
<div class="method_details first">
<h3 class="signature first" id="find-class_method">
- .<strong>find</strong>(first, last, obj = nil) {|obj| ... } ⇒ <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt>
+
+ <span class="overload">.<strong>find</strong>(v) ⇒ <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt> </span>
+
+ <span class="overload">.<strong>find</strong>(first, last, obj = nil) {|obj| ... } ⇒ <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt> </span>
+
</h3><div class="docstring">
<div class="discussion">
+
+ </div>
+</div>
+<div class="tags">
+
+ <p class="tag_title">Overloads:</p>
+ <ul class="overload">
+
+
+ <li class="overload_item">
+ <span class="signature">.<strong>find</strong>(v) ⇒ <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt> </span>
+ <div class="docstring">
+ <div class="discussion">
+
+<p>Searches the container for an element with an object equivalent to the argument.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>v</span>
+
+
+ <span class='type'></span>
+
+
+
+ —
+ <div class='inline'>
+<p>object</p>
+</div>
+
+ </li>
+
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt>)</span>
+
+
+
+ —
+ <div class='inline'>
+<p>iterator pointing the element with equivalent object.</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div>
+ </li>
+
+
+ <li class="overload_item">
+ <span class="signature">.<strong>find</strong>(first, last, obj = nil) {|obj| ... } ⇒ <tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt> </span>
+ <div class="docstring">
+ <div class="discussion">
+
<p>Searches the container for an element with an object equivalent to the third argument and/or validated with the provided block in a range of elements ([first,last)), 'obj' and returns an iterator to it if found, otherwise it returns an iterator to .</p>
</div>
</div>
@@ -686,21 +755,27 @@
</li>
</ul>
+</div>
+ </li>
+
+ </ul>
+
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-59
-60</pre>
+69
+70</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 59</span>
+ <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 69</span>
<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Yk::ESet (class)">ESet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='id identifier rubyid_last'>last</span><span class='comma'>,</span> <span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -819,15 +894,15 @@
<tr>
<td>
<pre class="lines">
-67
-68</pre>
+77
+78</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 67</span>
+ <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 77</span>
<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Yk::ESet (class)">ESet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_for_each'>for_each</span> <span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='id identifier rubyid_last'>last</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -994,30 +1069,98 @@
</div>
<div class="method_details ">
<h3 class="signature " id="erase-instance_method">
- #<strong>erase</strong>(first, last) ⇒ <tt>Object</tt>
+
+ <span class="overload">#<strong>erase</strong>(position) ⇒ <tt>Object</tt> </span>
+
+ <span class="overload">#<strong>erase</strong>(frist, last) ⇒ <tt>Object</tt> </span>
+
</h3><div class="docstring">
<div class="discussion">
-<p>Removes from the set container a range of elements ([first,last)). Iterators specifying a range within the set container to be removed: [first,last). i.e., the range includes all the elements between first and last, including the element pointed by first but not the one pointed by last.</p>
+ </div>
+</div>
+<div class="tags">
+
+ <p class="tag_title">Overloads:</p>
+ <ul class="overload">
+
+
+ <li class="overload_item">
+ <span class="signature">#<strong>erase</strong>(position) ⇒ <tt>Object</tt> </span>
+ <div class="docstring">
+ <div class="discussion">
+
+<p>Removes an element</p>
+
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
+ <span class='name'>position</span>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt>)</span>
+
+
+
+ </li>
+
+</ul>
+
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+
+ <li>
+
+
+ <span class='type'></span>
+
+
+
+
+ <div class='inline'>
+<p>ArgumentError raised when an argument is not a compatible iterator.</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div>
+ </li>
+
+
+ <li class="overload_item">
+ <span class="signature">#<strong>erase</strong>(frist, last) ⇒ <tt>Object</tt> </span>
+ <div class="docstring">
+ <div class="discussion">
+
+<p>Removes a range of elements ([first,last)) from the container. Iterators specifying a range within the set container to be removed: [first,last). i.e., the range includes all the elements between first and last, including the element pointed by first but not the one pointed by last.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
<span class='name'>first</span>
<span class='type'>(<tt><span class='object_link'><a href="ESet/Iterator.html" title="Yk::ESet::Iterator (class)">ESet::Iterator</a></span></tt>)</span>
@@ -1093,23 +1236,29 @@
</li>
</ul>
+</div>
+ </li>
+
+ </ul>
+
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-46
-47</pre>
+51
+52</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 46</span>
+ <pre class="code"><span class="info file"># File 'for_yard_product.rb', line 51</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_erase'>erase</span> <span class='id identifier rubyid_first'>first</span><span class='comma'>,</span> <span class='id identifier rubyid_last'>last</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_erase'>erase</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -1460,10 +1609,10 @@
</div>
</div>
<div id="footer">
- Generated on Thu Feb 20 23:18:19 2020 by
+ Generated on Fri Feb 21 22:30:56 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.7.0).
</div>
</div>
\ No newline at end of file