yard 0.2.3.5 → 0.4.0

data/spec/templates/examples/class001.txt

@@ -0,0 +1,31 @@
+----------------------------------------------------------- Class: A < B
+
+    Abstract. override this class
+
+    Comments 
+
+See Also:
+---------
+
+    - A
+    - http://example.com - Example
+
+Author:
+-------
+
+    Test
+
+Version:
+--------
+
+    1.0
+
+
+------------------------------------------------------------------------
+
+Instance methods:
+-----------------
+
+    a, initialize, method_missing
+
+

data/spec/templates/examples/method001.html

@@ -0,0 +1,96 @@
+<h1>Method: #m</h1>
+<dl class="box">
+  <dt class="r1 last">Defined in:</dt>
+  <dd class="r1 last">
+    (stdin)
+  </dd>
+</dl>
+<div class="clear"></div>
+
+<div id="method_details">
+  <div class="method_details first">
+  <p class="signature first" id="m-instance_method">
+  
+    - (<tt>String</tt>) <strong>m</strong>(x)  <span class="extras">(private)</span>
+  
+
+  
+    <span class="aliases">Also known as:
+    <span class="names">x</span>
+    </span>
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p class="note deprecated"><strong>Deprecated.</strong> for great justice</p>
+Comments
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>x</span>
+      
+      
+      
+        &mdash;
+        the x argument
+      
+    </li>
+  
+</ul>
+<h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+      
+        &mdash;
+        the result
+      
+    </li>
+  
+</ul>
+<h3>Raises:</h3>
+<ul class="raise">
+  
+    <li>
+      
+        <span class='type'>(<tt>Exception</tt>)</span>
+      
+      
+      
+      
+        &mdash;
+        hi!
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+7</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 7</span>
+
+def m(x) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>

data/spec/templates/examples/method001.txt

@@ -0,0 +1,28 @@
+------------------------------------------------------------- Method: #m
+                                                   (Defined in: (stdin))
+                                                     (Also known as: #x)
+
+    root.m(x) -> String (private)
+------------------------------------------------------------------------
+
+    Deprecated. for great justice
+
+    Comments 
+
+Parameters:
+-----------
+
+    (String) x - the x argument
+
+Returns:
+--------
+
+    (String) - the result
+
+Raises:
+-------
+
+    (Exception) - hi!
+
+
+

data/spec/templates/examples/method002.html

@@ -0,0 +1,81 @@
+<h1>Method: #m</h1>
+<dl class="box">
+  <dt class="r1 last">Defined in:</dt>
+  <dd class="r1 last">
+    (stdin)
+  </dd>
+</dl>
+<div class="clear"></div>
+
+<div id="method_details">
+  <div class="method_details first">
+  <p class="signature first" id="m-instance_method">
+  
+    - (<tt>Object</tt>) <strong>m</strong>(x, y)  <span class="extras">(private)</span>
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    Comments
+  </div>
+</div>
+<div class="tags">
+    <div class="docstring">
+  <div class="discussion">
+    
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>x</span>
+      
+      
+      
+        &mdash;
+        parameter x
+      
+    </li>
+  
+    <li>
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+        <span class='name'>y</span>
+      
+      
+      
+        &mdash;
+        parameter y
+      
+    </li>
+  
+</ul>
+
+</div>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+6</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 6</span>
+
+def m(x) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>

data/spec/templates/examples/method002.txt

@@ -0,0 +1,20 @@
+------------------------------------------------------------- Method: #m
+                                                   (Defined in: (stdin))
+
+    root.m(x, y) -> Object (private)
+------------------------------------------------------------------------
+
+    Comments 
+
+
+    
+Parameters:
+-----------
+
+    (String) x - parameter x
+
+    (Boolean) y - parameter y
+
+
+
+

data/spec/templates/examples/method003.html

@@ -0,0 +1,137 @@
+<h1>Method: #m</h1>
+<dl class="box">
+  <dt class="r1 last">Defined in:</dt>
+  <dd class="r1 last">
+    (stdin)
+  </dd>
+</dl>
+<div class="clear"></div>
+
+<div id="method_details">
+  <div class="method_details first">
+  <p class="signature first" id="m-instance_method">
+  
+    
+      <span class="overload">- (<tt>Object</tt>) <strong>m</strong>(x, y)  <span class="extras">(private)</span></span>
+    
+      <span class="overload">- (<tt>Object</tt>) <strong>m</strong>(x, y, z)  <span class="extras">(private)</span></span>
+    
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    Method comments
+  </div>
+</div>
+<div class="tags">
+    <h3>Overloads:</h3>
+  <ul class="overload">
+    
+      <li class="overload_item">
+        <span class="signature">- (<tt>Object</tt>) <strong>m</strong>(x, y)  <span class="extras">(private)</span></span>
+        <div class="docstring">
+  <div class="discussion">
+    Overload docstring
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>x</span>
+      
+      
+      
+        &mdash;
+        parameter x
+      
+    </li>
+  
+    <li>
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+        <span class='name'>y</span>
+      
+      
+      
+        &mdash;
+        parameter y
+      
+    </li>
+  
+</ul>
+
+</div>
+      </li>
+    
+      <li class="overload_item">
+        <span class="signature">- (<tt>Object</tt>) <strong>m</strong>(x, y, z)  <span class="extras">(private)</span></span>
+        <div class="docstring">
+  <div class="discussion">
+    
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>x</span>
+      
+      
+      
+        &mdash;
+        parameter x
+      
+    </li>
+  
+    <li>
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+        <span class='name'>y</span>
+      
+      
+      
+        &mdash;
+        parameter y
+      
+    </li>
+  
+    <li>
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+        <span class='name'>z</span>
+      
+      
+      
+        &mdash;
+        parameter z
+      
+    </li>
+  
+</ul>
+
+</div>
+      </li>
+    
+  </ul>
+
+</div>
+</div>
+</div>

data/spec/templates/examples/method003.txt

@@ -0,0 +1,45 @@
+------------------------------------------------------------- Method: #m
+                                                   (Defined in: (stdin))
+
+    root.m(x, y) -> Object (private)
+    root.m(x, y, z) -> Object (private)
+------------------------------------------------------------------------
+
+    Method comments 
+
+Overloads:
+----------
+
+------------------------------------------------------------------------
+    root.m(x, y) -> Object (private)
+------------------------------------------------------------------------
+    
+        Overload docstring 
+    
+    Parameters:
+    -----------
+    
+        (String) x - parameter x
+    
+        (Boolean) y - parameter y
+    
+    
+
+------------------------------------------------------------------------
+    root.m(x, y, z) -> Object (private)
+------------------------------------------------------------------------
+    
+        
+    Parameters:
+    -----------
+    
+        (String) x - parameter x
+    
+        (Boolean) y - parameter y
+    
+        (Boolean) z - parameter z
+    
+    
+
+
+

data/spec/templates/examples/module001.dot

@@ -0,0 +1,31 @@
+A [label="{module A|+ \#attr1 [RW]\l+ \#attr2 [R]\l|+ a\l+ \#a\l}" rank=sink];
+A_Y [label="{class Y||}" rank=sink];
+subgraph cluster_A_Y {
+  label = "Y"; labelloc=b;
+  
+}
+
+A_Q [label="{class Q||}" rank=sink];
+subgraph cluster_A_Q {
+  label = "Q"; labelloc=b;
+  
+}
+
+A_X [label="{class X||}" rank=sink];
+subgraph cluster_A_X {
+  label = "X"; labelloc=b;
+  
+}
+subgraph cluster_A {
+  label = "A"; labelloc=b;
+  
+    A_Z [label="{module Z||}" rank=sink];
+subgraph cluster_A_Z {
+  label = "Z"; labelloc=b;
+  
+}
+
+  
+}
+
+  A -> B [style=dotted arrowType=none];