netlinx-compile 3.0.0 → 3.1.0

data/doc/NetLinx/Compile/Script.html

@@ -128,7 +128,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#run-class_method" title="run (class method)">+ (Object) <strong>run</strong>(**kvargs) </a>
+      <a href="#run-class_method" title="run (class method)">+ (Object) <strong>run</strong>(**kwargs) </a>
     
 
     
@@ -161,7 +161,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="run-class_method">
   
-    + (<tt>Object</tt>) <strong>run</strong>(**kvargs) 
+    + (<tt>Object</tt>) <strong>run</strong>(**kwargs) 
   
 
   
@@ -176,7 +176,49 @@
   </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">:argv</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>A convenience to override ARGV, like for testing.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
 
 </div><table class="source_code">
   <tr>
@@ -184,8 +226,6 @@
       <pre class="lines">
 
 
-13
-14
 15
 16
 17
@@ -280,14 +320,14 @@
 106
 107
 108
-109</pre>
+109
+110</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/script.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/script.rb', line 15</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kvargs'>kvargs</span><span class='rparen'>)</span>
-  <span class='comment'># :argv is a convenience to override ARGV, like for testing.
-</span>  <span class='id identifier rubyid_args'>args</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'>:argv</span><span class='comma'>,</span> <span class='const'>ARGV</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_args'>args</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'>:argv</span><span class='comma'>,</span> <span class='const'>ARGV</span>
 
   <span class='comment'># Command line options.
 </span>  <span class='ivar'>@options</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> \
@@ -392,7 +432,7 @@
 </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/Compiler.html

@@ -152,7 +152,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Compiler) <strong>initialize</strong>(**kvargs) </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Compiler) <strong>initialize</strong>(**kwargs) </a>
     
 
     
@@ -185,7 +185,7 @@ default installation path.</p>
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    - (<tt><span class='object_link'><a href="" title="NetLinx::Compiler (class)">Compiler</a></span></tt>) <strong>initialize</strong>(**kvargs) 
+    - (<tt><span class='object_link'><a href="" title="NetLinx::Compiler (class)">Compiler</a></span></tt>) <strong>initialize</strong>(**kwargs) 
   
 
   
@@ -195,29 +195,110 @@ default installation path.</p>
   <div class="discussion">
     
 <p>Checks for the AMX NetLinx compiler (third-party software, nlrc.exe) at the
-default installation path. This can be overridden by specifying
-:compiler_path.</p>
+default installation path.</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">:compiler_exe</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>&#39;nlrc.exe&#39;</tt>
+            
+          </span>
+          
+        </li>
+      
+        <li>
+          <span class="name">:compiler_path</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Recommend a directory to look for the compiler_exe.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:use_wine</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>false</tt>
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Set to true to force `wine` at the front of the compiler command. This is
+automatic if nlrc.exe is installed at Wine&#39;s default Program Files
+path.</p>
+</div>
+          
+        </li>
+      
+    </ul>
   
 
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="NoCompilerError.html" title="NetLinx::NoCompilerError (class)">NetLinx::NoCompilerError</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Compiler not found.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-13
-14
-15
-16
-17
-18
-19
-20
 21
 22
 23
@@ -230,31 +311,55 @@ default installation path. This can be overridden by specifying
 30
 31
 32
-33</pre>
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler.rb', line 21</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_exe</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nlrc.exe</span><span class='tstring_end'>&#39;</span></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_exe</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_exe</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nlrc.exe</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_user_specified_path'>user_specified_path</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_path</span><span class='comma'>,</span> <span class='kw'>nil</span>
+  <span class='ivar'>@use_wine</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'>:use_wine</span><span class='comma'>,</span> <span class='kw'>false</span>
   
-  <span class='ivar'>@compiler_path</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_path</span><span class='comma'>,</span>
-    <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>C:\Program Files (x86)\Common Files\AMXShare\COM</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'># 64-bit O/S path
-</span>    
-  <span class='comment'># Check for NetLinx compiler at :compiler_path or the 64-bit O/S path.
-</span>  <span class='kw'>unless</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nlrc.exe</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='ivar'>@compiler_path</span><span class='rparen'>)</span>
-    <span class='comment'># Compiler not found. Try 32-bit O/S path.
-</span>    <span class='ivar'>@compiler_path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>C:\Program Files\Common Files\AMXShare\COM</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-    <span class='kw'>unless</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nlrc.exe</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='ivar'>@compiler_path</span><span class='rparen'>)</span>
-      <span class='comment'># ---------------------------------------------------------
-</span>      <span class='comment'># TODO: Check if the compiler was added to the system path.
-</span>      <span class='comment'>#       Execute system(&#39;nlrc&#39;).
-</span>      <span class='comment'># ---------------------------------------------------------
-</span>      
-      <span class='comment'># Compiler not found.
-</span>      <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NetLinx</span><span class='op'>::</span><span class='const'>NoCompilerError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>The NetLinx compiler (nlrc.exe) could not be found on the system.</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_default_paths'>default_paths</span> <span class='op'>=</span> <span class='lbracket'>[</span>
+    <span class='id identifier rubyid_user_specified_path'>user_specified_path</span><span class='comma'>,</span>
+    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>C:\Program Files (x86)\Common Files\AMXShare\COM</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># 64-bit O/S path
+</span>    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>C:\Program Files\Common Files\AMXShare\COM</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>       <span class='comment'># 32-bit O/S path
+</span>    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~/.wine/drive_c/Program\ Files/Common\ Files/AMXShare/COM</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># Wine path
+</span>  <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
+  
+  <span class='comment'># Check for NetLinx compiler.
+</span>  <span class='id identifier rubyid_default_paths'>default_paths</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
+    <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='ivar'>@compiler_exe</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
+      <span class='ivar'>@compiler_path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
+      <span class='kw'>break</span>
     <span class='kw'>end</span>
   <span class='kw'>end</span>
+  
+  <span class='comment'># ---------------------------------------------------------
+</span>  <span class='comment'># TODO: Check if the compiler was added to the system path.
+</span>  <span class='comment'>#       Execute system(@compiler_exe).
+</span>  <span class='comment'># ---------------------------------------------------------
+</span>  
+  <span class='comment'># Compiler not found.
+</span>  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NetLinx</span><span class='op'>::</span><span class='const'>NoCompilerError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The NetLinx compiler (</span><span class='embexpr_beg'>#{</span><span class='ivar'>@compiler_exe</span><span class='embexpr_end'>}</span><span class='tstring_content'>) could not be found on the system.</span><span class='tstring_end'>&quot;</span></span> \
+    <span class='kw'>unless</span> <span class='ivar'>@compiler_path</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -280,8 +385,7 @@ default installation path. This can be overridden by specifying
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Compile the specified object with the NetLinx compiler. See
-Test::NetLinx::Compilable.</p>
+<p>Compile the specified object with the NetLinx compiler.</p>
 
 
   </div>
@@ -289,28 +393,19 @@ Test::NetLinx::Compilable.</p>
 <div class="tags">
   
 
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>Test::NetLinx::Compilable.</li>
+    
+  </ul>
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
 53
 54
 55
@@ -332,10 +427,28 @@ Test::NetLinx::Compilable.</p>
 71
 72
 73
-74</pre>
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler.rb', line 37</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler.rb', line 53</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_compile'>compile</span><span class='lparen'>(</span><span class='id identifier rubyid_compilable'>compilable</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_compiler'>compiler</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span> <span class='ivar'>@compiler_exe</span><span class='comma'>,</span> <span class='ivar'>@compiler_path</span>
@@ -354,7 +467,9 @@ Test::NetLinx::Compilable.</p>
     
     <span class='comment'># Run the NetLinx compiler.
 </span>    <span class='comment'># Note: NLRC.exe v2.1 freaks out if empty arguments (&quot;&quot;) are in the command.
-</span>    <span class='id identifier rubyid_cmd'>cmd</span>  <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_compiler'>compiler</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target_file'>target_file</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>
+</span>    <span class='id identifier rubyid_cmd'>cmd</span>  <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
+    <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wine </span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='ivar'>@use_wine</span> <span class='kw'>or</span> <span class='id identifier rubyid_compiler'>compiler</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/.wine/</span><span class='tstring_end'>&#39;</span></span>
+    <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_compiler'>compiler</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_target_file'>target_file</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>
     <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_include_paths'>include_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_include_paths'>include_paths</span>
     <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_module_paths'>module_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span>  <span class='kw'>if</span> <span class='id identifier rubyid_module_paths'>module_paths</span>
     <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_library_paths'>library_paths</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_library_paths'>library_paths</span>
@@ -385,7 +500,7 @@ Test::NetLinx::Compilable.</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/CompilerResult.html

@@ -336,7 +336,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#error_items-instance_method" title="#error_items (instance method)">- (Object) <strong>error_items</strong> </a>
+      <a href="#error_items-instance_method" title="#error_items (instance method)">- (Array&lt;String&gt;) <strong>error_items</strong> </a>
     
 
     
@@ -351,7 +351,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>An enumerable list of errors.</p>
+<p>A list of errors.</p>
 </div></span>
   
 </li>
@@ -360,7 +360,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (CompilerResult) <strong>initialize</strong>(**kvargs) </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (CompilerResult) <strong>initialize</strong>(**kwargs) </a>
     
 
     
@@ -377,7 +377,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Args:  stream – The raw stream of text returned by the compiler.</p>
+<p>A new instance of CompilerResult.</p>
 </div></span>
   
 </li>
@@ -401,7 +401,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Compile was successful?.</p>
+<p>True if compile was successful.</p>
 </div></span>
   
 </li>
@@ -410,7 +410,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#target_file-instance_method" title="#target_file (instance method)">- (Object) <strong>target_file</strong> </a>
+      <a href="#target_file-instance_method" title="#target_file (instance method)">- (String) <strong>target_file</strong> </a>
     
 
     
@@ -425,7 +425,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the absolute path of the source code file that was compiled.</p>
+<p>The absolute path of the source code file that was compiled.</p>
 </div></span>
   
 </li>
@@ -449,7 +449,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Alias of #stream.</p>
+<p>Alias of <span class='object_link'><a href="#stream-instance_method" title="NetLinx::CompilerResult#stream (method)">#stream</a></span>.</p>
 </div></span>
   
 </li>
@@ -458,7 +458,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#warning_items-instance_method" title="#warning_items (instance method)">- (Object) <strong>warning_items</strong> </a>
+      <a href="#warning_items-instance_method" title="#warning_items (instance method)">- (Array&lt;String&gt;) <strong>warning_items</strong> </a>
     
 
     
@@ -473,7 +473,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>An enumerable list of warnings.</p>
+<p>A list of warnings.</p>
 </div></span>
   
 </li>
@@ -488,7 +488,7 @@
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    - (<tt><span class='object_link'><a href="" title="NetLinx::CompilerResult (class)">CompilerResult</a></span></tt>) <strong>initialize</strong>(**kvargs) 
+    - (<tt><span class='object_link'><a href="" title="NetLinx::CompilerResult (class)">CompilerResult</a></span></tt>) <strong>initialize</strong>(**kwargs) 
   
 
   
@@ -497,26 +497,115 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Args:</p>
-
-<pre class="code ruby"><code class="ruby">stream -- The raw stream of text returned by the compiler.
-compiler_target_files  -- See Compilable interface.
-compiler_include_paths -- See Compilable interface.
-compiler_module_paths  -- See Compilable interface.
-compiler_library_paths -- See Compilable interface.</code></pre>
+<p>Returns a new instance of CompilerResult</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">:stream</span>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>The raw stream of text returned by the compiler.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:compiler_target_files</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>See Compilable interface.</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>See Compilable interface.</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>See Compilable interface.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:compiler_library_paths</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>See Compilable interface.</p>
+</div>
+          
+        </li>
+      
+    </ul>
   
 
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
+27
 28
 29
 30
@@ -532,19 +621,18 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 40
 41
 42
-43
-44</pre>
+43</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 28</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 27</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'>@stream</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'>:stream</span><span class='comma'>,</span>   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></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'>@stream</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'>:stream</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
   
-  <span class='ivar'>@compiler_target_files</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_target_files</span><span class='comma'>,</span>  <span class='lbracket'>[</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='ivar'>@compiler_library_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_library_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>      
+  <span class='ivar'>@compiler_target_files</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_target_files</span><span class='comma'>,</span>  <span class='lbracket'>[</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='ivar'>@compiler_library_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_library_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>      
   
   <span class='comment'># Capture error and warning counts.
 </span>  <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='kw'>nil</span>
@@ -876,7 +964,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <div class="method_details first">
   <h3 class="signature first" id="error_items-instance_method">
   
-    - (<tt>Object</tt>) <strong>error_items</strong> 
+    - (<tt>Array&lt;String&gt;</tt>) <strong>error_items</strong> 
   
 
   
@@ -885,13 +973,31 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>An enumerable list of errors.</p>
+<p>Returns a list of errors.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a list of errors.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -899,12 +1005,12 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <pre class="lines">
 
 
+66
 67
-68
-69</pre>
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 67</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_error_items'>error_items</span>
   <span class='ivar'>@stream</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(^ERROR: .*$)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbrace'>}</span>
@@ -926,7 +1032,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Compile was successful?</p>
+<p>Returns true if compile was successful.</p>
 
 
   </div>
@@ -943,6 +1049,11 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       
       
       
+        &mdash;
+        <div class='inline'>
+<p>true if compile was successful.</p>
+</div>
+      
     </li>
   
 </ul>
@@ -953,12 +1064,12 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <pre class="lines">
 
 
+56
 57
-58
-59</pre>
+58</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 57</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 56</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
   <span class='ivar'>@errors</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@warnings</span> <span class='op'>==</span> <span class='int'>0</span>
@@ -971,7 +1082,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <div class="method_details ">
   <h3 class="signature " id="target_file-instance_method">
   
-    - (<tt>Object</tt>) <strong>target_file</strong> 
+    - (<tt>String</tt>) <strong>target_file</strong> 
   
 
   
@@ -987,6 +1098,24 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the absolute path of the source code file that was compiled.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -994,12 +1123,12 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <pre class="lines">
 
 
+51
 52
-53
-54</pre>
+53</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 52</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 51</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_target_file'>target_file</span>
   <span class='ivar'>@compiler_target_files</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
@@ -1021,7 +1150,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Alias of #stream.</p>
+<p>Alias of <span class='object_link'><a href="#stream-instance_method" title="NetLinx::CompilerResult#stream (method)">#stream</a></span>.</p>
 
 
   </div>
@@ -1035,12 +1164,12 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <pre class="lines">
 
 
+46
 47
-48
-49</pre>
+48</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 47</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 46</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
   <span class='ivar'>@stream</span>
@@ -1053,7 +1182,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <div class="method_details ">
   <h3 class="signature " id="warning_items-instance_method">
   
-    - (<tt>Object</tt>) <strong>warning_items</strong> 
+    - (<tt>Array&lt;String&gt;</tt>) <strong>warning_items</strong> 
   
 
   
@@ -1062,13 +1191,31 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>An enumerable list of warnings.</p>
+<p>Returns a list of warnings.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a list of warnings.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -1076,12 +1223,12 @@ compiler_library_paths -- See Compilable interface.</code></pre>
       <pre class="lines">
 
 
+61
 62
-63
-64</pre>
+63</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 62</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 61</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_warning_items'>warning_items</span>
   <span class='ivar'>@stream</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(^WARNING: .*$)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbrace'>}</span>
@@ -1096,7 +1243,7 @@ compiler_library_paths -- See Compilable interface.</code></pre>
 </div>
 
     <div id="footer">
-  Generated on Mon Jan 26 15:35:58 2015 by
+  Generated on Mon Jan 26 15:36:25 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>