yard 0.4.0 → 0.5.0

data/spec/templates/examples/method005.txt

@@ -0,0 +1,33 @@
+------------------------------------------------------------- Method: #m
+                                                   (Defined in: (stdin))
+
+    root.m(a) -> void 
+    root.m(b) 
+------------------------------------------------------------------------
+
+    
+Overloads:
+----------
+
+------------------------------------------------------------------------
+    root.m(a) -> void 
+------------------------------------------------------------------------
+    
+        This method returns an undefined value.
+        
+    
+
+------------------------------------------------------------------------
+    root.m(b) 
+------------------------------------------------------------------------
+    
+        
+    Parameters:
+    -----------
+    
+        (String) b - hi
+    
+    
+
+
+

data/spec/templates/examples/module001.dot

@@ -1,4 +1,4 @@
-A [label="{module A|+ \#attr1 [RW]\l+ \#attr2 [R]\l|+ a\l+ \#a\l}" rank=sink];
+A [label="{module A|+ \#attr1 [RW]\l+ \#attr2 [R]\l+ \#attr3 [RW]\l|+ a\l+ \#a\l+ \#test_multi_overload\l+ \#test_overload\l+ \#void_meth\ \:\ void\l}" rank=sink];
 A_Y [label="{class Y||}" rank=sink];
 subgraph cluster_A_Y {
   label = "Y"; labelloc=b;

data/spec/templates/examples/module001.html

@@ -64,14 +64,19 @@
   
   
   
-  <h2>Attribute Summary</h2>
+  <h2>Instance Attribute Summary</h2>
   <ul class="summary">
     
       <li class="public ">
-  <span class="summary_signature"><a  title="#attr1 (instance method)">- (Object) <strong>attr1</strong> </a>
-  
+  <span class="summary_signature">
+    
+      <a  title="#attr1 (instance method)">- <strong>attr1</strong> </a>
+    
+
+    
   </span>
   
+  
     
     
   
@@ -80,16 +85,21 @@
   
 
   
-    <span class="summary_desc">Returns the value of attribute +attr1+.</span>
+    <span class="summary_desc">Returns the value of attribute attr1.</span>
   
 </li>
 
     
       <li class="public ">
-  <span class="summary_signature"><a  title="#attr2 (instance method)">- (Object) <strong>attr2</strong> </a>
-  
+  <span class="summary_signature">
+    
+      <a  title="#attr2 (instance method)">- <strong>attr2</strong> </a>
+    
+
+    
   </span>
   
+  
     <span class="note title readonly">readonly</span>
     
   
@@ -98,7 +108,30 @@
   
 
   
-    <span class="summary_desc">Returns the value of attribute +attr2+.</span>
+    <span class="summary_desc">Returns the value of attribute attr2.</span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#attr3 (instance method)">- <strong>attr3</strong> </a>
+    
+
+    
+  </span>
+  
+  
+    
+    
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
   
 </li>
 
@@ -106,17 +139,71 @@
   </ul>
 
 
-  <h2>Method Summary</h2>
+  <h2>Class Method Summary</h2>
+
   <ul class="summary">
     
       <li class="public ">
-  <span class="summary_signature"><a  title="a (class method)">+ (Object) <strong>a</strong> </a>
+  <span class="summary_signature">
+    
+      <a  title="a (class method)">+ <strong>a</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
+  
+</li>
+
+    
+  </ul>
+
+  <h2>Instance Method Summary</h2>
+
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#a (instance method)">- <strong>a</strong> </a>
+    
+
+    
+      (also: #b)
+    
+  </span>
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#test_multi_overload (instance method)">- <strong>test_multi_overload</strong>(*args) </a>
+    
+
+    
   </span>
   
   
   
   
+  
 
   
     <span class="summary_desc"></span>
@@ -125,15 +212,38 @@
 
     
       <li class="public ">
-  <span class="summary_signature"><a  title="#a (instance method)">- (Object) <strong>a</strong> </a>
+  <span class="summary_signature">
+    
+      <a  title="#test_overload (instance method)">- <strong>test_overload</strong>(a) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
   
-    (also: #b)
+
+  
+    <span class="summary_desc">hello2.</span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#void_meth (instance method)">- <strong>void_meth</strong> </a>
+    
+
+    
   </span>
   
   
   
   
+  
 
   
     <span class="summary_desc"></span>
@@ -143,7 +253,6 @@
     
   </ul>
 
-
   
   
   
@@ -152,8 +261,8 @@
   <h3 class="inherited">Methods included from B</h3>
   <p class="inherited">#c, #d</p>
 
-  <div id="attr_details">
-    <h2>Attribute Details</h2>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
     
       
       <span id="attr1=-instance_method"></span>
@@ -161,13 +270,13 @@
       <div class="method_details first">
   <p class="signature first" id="attr1-instance_method">
   
-    - (<tt>Object</tt>) <strong>attr1</strong> 
+    - <strong>attr1</strong> 
   
 
   
 </p><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute +attr1+
+    Returns the value of attribute attr1
 
   </div>
 </div>
@@ -179,12 +288,12 @@
       <pre class="lines">
 
 
-8
-9
-10</pre>
+10
+11
+12</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 8</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 10</span>
 
 def attr1
   @attr1
@@ -200,13 +309,13 @@ end</pre>
       <div class="method_details ">
   <p class="signature " id="attr2-instance_method">
   
-    - (<tt>Object</tt>) <strong>attr2</strong>  <span class="extras">(readonly)</span>
+    - <strong>attr2</strong>  <span class="extras">(readonly)</span>
   
 
   
 </p><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute +attr2+
+    Returns the value of attribute attr2
 
   </div>
 </div>
@@ -218,12 +327,12 @@ end</pre>
       <pre class="lines">
 
 
-9
-10
-11</pre>
+11
+12
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 9</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
 
 def attr2
   @attr2
@@ -233,16 +342,127 @@ end</pre>
 </table>
 </div>
     
+      
+      <span id="attr3=-instance_method"></span>
+      <span id="attr3-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="attr3-instance_method">
+  
+    
+      <span class="overload">- (<tt>String</tt>) <strong>attr3</strong> </span>
+    
+      <span class="overload">- <strong>attr3=</strong>(value) </span>
+    
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+  <h3>Overloads:</h3>
+  <ul class="overload">
+    
+      
+      <li class="overload_item">
+        <span class="signature">- (<tt>String</tt>) <strong>attr3</strong> </span>
+        <div class="docstring">
+  <div class="discussion">
+    A string
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+      
+        &mdash;
+        a string
+      
+    </li>
+  
+</ul>
+
+</div>
+      </li>
+    
+      
+      <li class="overload_item">
+        <span class="signature">- <strong>attr3=</strong>(value) </span>
+        <div class="docstring">
+  <div class="discussion">
+    <p class="note returns_void">This method returns an undefined value.</p>
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>value</span>
+      
+      
+      
+        &mdash;
+        sets the string
+      
+    </li>
+  
+</ul>
+
+</div>
+      </li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+18
+19
+20</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 18</span>
+
+def attr3
+  @attr3
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
   </div>
 
 
-  <div id="method_details">
-    <h2>Method Details</h2>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+    
     
       <div class="method_details first">
   <p class="signature first" id="a-class_method">
   
-    + (<tt>Object</tt>) <strong>a</strong> 
+    + <strong>a</strong> 
   
 
   
@@ -252,10 +472,10 @@ end</pre>
       <pre class="lines">
 
 
-11</pre>
+20</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 20</span>
 
 def self.a; end</pre>
     </td>
@@ -263,15 +483,21 @@ def self.a; end</pre>
 </table>
 </div>
     
-      <div class="method_details ">
-  <p class="signature " id="a-instance_method">
+  </div>
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="a-instance_method">
   
-    - (<tt>Object</tt>) <strong>a</strong> 
+    - <strong>a</strong> 
   
 
   
     <span class="aliases">Also known as:
-    <span class="names">b</span>
+    <span class="names"><span id='b-instance_method'>b</span></span>
     </span>
   
 </p><table class="source_code">
@@ -280,15 +506,143 @@ def self.a; end</pre>
       <pre class="lines">
 
 
-12</pre>
+21</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 12</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 21</span>
 
 def a; end</pre>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="test_multi_overload-instance_method">
+  
+    
+      <span class="overload">- <strong>test_multi_overload</strong>(a) </span>
+    
+      <span class="overload">- <strong>test_multi_overload</strong>(a, b) </span>
+    
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 31</span>
+
+def test_multi_overload(*args) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="test_overload-instance_method">
+  
+    - <strong>test_overload</strong>(a) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="docstring">
+  <div class="discussion">
+    hello2
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>a</span>
+      
+      
+      
+        &mdash;
+        hi
+      
+    </li>
+  
+</ul>
+
+</div>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 27</span>
+
+def test_overload(*args) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="void_meth-instance_method">
+  
+    - <strong>void_meth</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p class="note returns_void">This method returns an undefined value.</p>
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 34</span>
+
+def void_meth; end</pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>