runner_rb.html in ruby-vpi-7.1.0

- old
+ new

@@ -54,11 +54,11 @@
       <td>lib/ruby-vpi/runner.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Aug 29 11:48:52 PDT 2006</td>
+      <td>Tue Aug 29 22:50:44 PDT 2006</td>
     </tr>
     </table>
   </div>
   <!-- banner header -->
 
@@ -66,36 +66,112 @@
 
 
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+A template to simplify building and running examples. This file is meant to
+be embedded in another Rakefile, which bears the responsibility of defining
+the following variables.
+</p>
+<h1>Required variables</h1>
+<table>
+<tr><td valign="top">SIMULATOR_SOURCES:</td><td>Array of paths to source files needed by the simulator.
 
+</td></tr>
+<tr><td valign="top">SIMULATOR_TARGET:</td><td>Name of the Verilog module to be simulated.
+
+</td></tr>
+<tr><td valign="top">SIMULATOR_ARGS:</td><td>A hash containing keys for each simulator task (same as Rakefile task
+names) and values containing command-line arguments for each simulator.
+
+</td></tr>
+</table>
+<h1>Usage</h1>
+<p>
+When using one simulator after another, ensure that Ruby-VPI is properly
+compiled for the new simulator by invoking the <em>clobber</em> cleaning
+task.
+</p>
+
+    </div>
+
     <div id="requires-list">
       <h3 class="section-bar">Required files</h3>
 
       <div class="name-list">
-      ruby-vpi&nbsp;&nbsp;
+      rake/clean&nbsp;&nbsp;
+      ruby-vpi/rake&nbsp;&nbsp;
+      rbconfig&nbsp;&nbsp;
       </div>
     </div>
 
    </div>
 
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
 
+      <div class="name-list">
+      <a href="#M000001">object_file_path</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
   </div>
 
 
     <!-- if includes -->
 
     <div id="section">
 
 
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
 
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">LIBRARY_PATH</td>
+          <td>=</td>
+          <td class="context-item-value">File.join(File.dirname(__FILE__), '..')</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">OBJECT_PATH</td>
+          <td>=</td>
+          <td class="context-item-value">File.join(LIBRARY_PATH, '..', 'obj')</td>
+        </tr>
+        </table>
+      </div>
+    </div>
 
 
+
       
 
 
     <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="runner_rb.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('runner_rb.src/M000001.html');return false;">
+          <span class="method-name">object_file_path</span><span class="method-args">(aSimId, aShared = false)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the path to the Ruby-VPI object file for the given simulator.
+</p>
+        </div>
+      </div>
+
+
+    </div>
 
 
   </div>
 
 
\ No newline at end of file