netlinx-compile 3.0.0 → 3.1.0

data/doc/NetLinx/NoCompilerError.html

@@ -104,8 +104,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Raised when the NetLinx compiler (nlrc.exe) cannot be found on the system.
-See NetLinx::Compiler.</p>
+<p>Raised when the NetLinx compiler (nlrc.exe) cannot be found on the system.</p>
 
 
   </div>
@@ -113,6 +112,13 @@ See NetLinx::Compiler.</p>
 <div class="tags">
   
 
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Compiler.html" title="NetLinx::Compiler (class)">Compiler</a></span></li>
+    
+  </ul>
+
 </div>
 
 
@@ -126,7 +132,7 @@ See NetLinx::Compiler.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:58 2015 by
+  Generated on Mon Jan 26 15:36:24 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/NetLinx/SourceFile.html

@@ -99,7 +99,18 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>A NetLinx source code file. Typically .axs or .axi.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
 
+</div>
 
 
 
@@ -155,9 +166,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>See Test::NetLinx::Compilable interface.</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -179,9 +188,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>See Test::NetLinx::Compilable interface.</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -203,9 +210,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>See Test::NetLinx::Compilable interface.</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -227,9 +232,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>See Test::NetLinx::Compilable interface.</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -237,7 +240,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (SourceFile) <strong>initialize</strong>(**kvargs) </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (SourceFile) <strong>initialize</strong>(**kwargs) </a>
     
 
     
@@ -254,7 +257,8 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Parameters:   file: Name or path of the file to compile.</p>
+<p>NOTE: SourceFile searches the body of the source file to automatically
+determine include and module paths.</p>
 </div></span>
   
 </li>
@@ -269,7 +273,7 @@
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    - (<tt><span class='object_link'><a href="" title="NetLinx::SourceFile (class)">SourceFile</a></span></tt>) <strong>initialize</strong>(**kvargs) 
+    - (<tt><span class='object_link'><a href="" title="NetLinx::SourceFile (class)">SourceFile</a></span></tt>) <strong>initialize</strong>(**kwargs) 
   
 
   
@@ -278,19 +282,82 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Parameters:</p>
-
-<pre class="code ruby"><code class="ruby">file: Name or path of the file to compile.
-compiler_include_paths: Array of additional paths for the compiler to find include files.
-compiler_module_paths: Array of additional paths for the compiler to find module files.
-  NOTE: SourceFile already searches the body of the source file to automatically determine
-        include and module paths.</code></pre>
+<p>NOTE: SourceFile searches the body of the source file to automatically
+determine include and module paths.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>kwargs</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a customizable set of options</p>
+</div>
+      
+    </li>
   
+</ul>
+
+  
+    
+    
+    <p class="tag_title">Options Hash (<tt>**kwargs</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:file</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Name or path of the file to compile.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:compiler_include_paths</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Additional paths for the compiler to find include files.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:compiler_module_paths</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Additional paths for the compiler to find module files.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
 
 </div><table class="source_code">
   <tr>
@@ -298,8 +365,6 @@ compiler_module_paths: Array of additional paths for the compiler to find module
       <pre class="lines">
 
 
-10
-11
 12
 13
 14
@@ -336,15 +401,17 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 45
 46
 47
-48</pre>
+48
+49
+50</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 10</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 12</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kvargs'>kvargs</span><span class='rparen'>)</span>
-  <span class='ivar'>@compiler_target_files</span>  <span class='op'>=</span> <span class='lbracket'>[</span> <span class='lparen'>(</span><span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:file</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='rbracket'>]</span>
-  <span class='ivar'>@compiler_include_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_include_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='ivar'>@compiler_module_paths</span>  <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_module_paths</span><span class='comma'>,</span>  <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
+  <span class='ivar'>@compiler_target_files</span>  <span class='op'>=</span> <span class='lbracket'>[</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:file</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='rbracket'>]</span>
+  <span class='ivar'>@compiler_include_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_include_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@compiler_module_paths</span>  <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_module_paths</span><span class='comma'>,</span>  <span class='lbracket'>[</span><span class='rbracket'>]</span>
   
   <span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@compiler_target_files</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
   
@@ -418,14 +485,14 @@ compiler_module_paths: Array of additional paths for the compiler to find module
       <pre class="lines">
 
 
-71
-72
 73
 74
-75</pre>
+75
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 71</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 73</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_compile'>compile</span>
   <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netlinx/compiler</span><span class='tstring_end'>&#39;</span></span>
@@ -449,26 +516,31 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>See Test::NetLinx::Compilable interface.</p>
-
 
   </div>
 </div>
 <div class="tags">
   
 
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>lib/test/netlinx/compilable.rb interface.</li>
+    
+  </ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-56
-57
-58</pre>
+58
+59
+60</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 58</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_compiler_include_paths'>compiler_include_paths</span>
   <span class='ivar'>@compiler_include_paths</span>
@@ -490,26 +562,31 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>See Test::NetLinx::Compilable interface.</p>
-
 
   </div>
 </div>
 <div class="tags">
   
 
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>lib/test/netlinx/compilable.rb interface.</li>
+    
+  </ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-66
-67
-68</pre>
+68
+69
+70</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 66</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 68</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_compiler_library_paths'>compiler_library_paths</span>
   <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -531,26 +608,31 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>See Test::NetLinx::Compilable interface.</p>
-
 
   </div>
 </div>
 <div class="tags">
   
 
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>lib/test/netlinx/compilable.rb interface.</li>
+    
+  </ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-61
-62
-63</pre>
+63
+64
+65</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 61</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 63</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_compiler_module_paths'>compiler_module_paths</span>
   <span class='ivar'>@compiler_module_paths</span>
@@ -572,26 +654,31 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>See Test::NetLinx::Compilable interface.</p>
-
 
   </div>
 </div>
 <div class="tags">
   
 
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>lib/test/netlinx/compilable.rb interface.</li>
+    
+  </ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-51
-52
-53</pre>
+53
+54
+55</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 51</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/source_file.rb', line 53</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_compiler_target_files'>compiler_target_files</span>
   <span class='ivar'>@compiler_target_files</span>
@@ -606,7 +693,7 @@ compiler_module_paths: Array of additional paths for the compiler to find module
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:58 2015 by
+  Generated on Mon Jan 26 15:36:24 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/_index.html

@@ -206,7 +206,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:57 2015 by
+  Generated on Mon Jan 26 15:36:24 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/file.README.html

@@ -108,7 +108,7 @@ href="https://sourceforge.net/p/netlinx-compile/wiki/Home/">sourceforge.net/p/ne
 </div></div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:58 2015 by
+  Generated on Mon Jan 26 15:36:24 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>

data/doc/file.license.html

@@ -61,10 +61,10 @@
 
     <iframe id="search_frame"></iframe>
 
-    <div id="content"><div id='filecontents'>Copyright 2013 Alex McLain<br/><br/>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br/>you may not use this file except in compliance with the License.<br/>You may obtain a copy of the License at<br/><br/> http://www.apache.org/licenses/LICENSE-2.0<br/><br/>Unless required by applicable law or agreed to in writing, software<br/>distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br/>WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br/>See the License for the specific language governing permissions and<br/>limitations under the License.</div></div>
+    <div id="content"><div id='filecontents'>Copyright 2013, 2015 Alex McLain<br/><br/>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br/>you may not use this file except in compliance with the License.<br/>You may obtain a copy of the License at<br/><br/> http://www.apache.org/licenses/LICENSE-2.0<br/><br/>Unless required by applicable law or agreed to in writing, software<br/>distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br/>WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br/>See the License for the specific language governing permissions and<br/>limitations under the License.</div></div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:58 2015 by
+  Generated on Mon Jan 26 15:36:24 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.5).
 </div>