ExtensionHandler.html in netlinx-compile-3.1.0

- old
+ new

@@ -255,21 +255,21 @@
   
   
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns true if this ExtensionHandler can handle the specified file
+<p>Returns true if this <span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">ExtensionHandler</a></span> can handle the specified file
 extension.</p>
 </div></span>
   
 </li>
 
       
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (ExtensionHandler) <strong>initialize</strong>(**kvargs) </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (ExtensionHandler) <strong>initialize</strong>(**kwargs) </a>
     
 
     
   </span>
   
@@ -282,12 +282,11 @@
   
   
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Parameters:   extensions: An array of file extensions (without the leading
-dot)               that this ExtensionHandler supports.</p>
+<p>A new instance of ExtensionHandler.</p>
 </div></span>
   
 </li>
 
       
@@ -307,12 +306,13 @@
   
   
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns true if the ExtensionHandler handles a workspace file (as opposed
-to a source code file).</p>
+<p>Workspace files are significant because they contain information about a
+project, connection settings for a master, and possibly multiple systems
+that need to be compiled.</p>
 </div></span>
   
 </li>
 
       
@@ -323,67 +323,136 @@
   <h2>Constructor Details</h2>
   
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    - (<tt><span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">ExtensionHandler</a></span></tt>) <strong>initialize</strong>(**kvargs) 
+    - (<tt><span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">ExtensionHandler</a></span></tt>) <strong>initialize</strong>(**kwargs) 
   
 
   
 
   
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Parameters:</p>
+<p>Returns a new instance of ExtensionHandler</p>
 
-<pre class="code ruby"><code class="ruby">extensions: An array of file extensions (without the leading dot)
-            that this ExtensionHandler supports.
 
-usurps:     Future.
-            Lets this ExtensionHandler take priority over other
-            ones. For example, most third-party handlers would
-            probably usurp the .apw NetLinx Studio workspace
-            extension.
-
-is_a_workspace: Set to true if this ExtensionHandler is for
-            compiling a workspace. False by default. This
-            parameter assists with smart compiling, as
-            ExtensionDiscovery can return all workspace_handlers.
-
-handler_class: A reference to the class that should be instantiated
-            if this handler is selected. For example,
-            NetLinx::SourceFile is the class that handles files
-            with the .axs extension.</code></pre>
-
-
   </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">:extensions</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>File extensions (without the leading dot) that this ExtensionHandler
+supports.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:usurps</span>
+          <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Future. Lets this ExtensionHandler take priority over other ones. For
+example, most third-party handlers would probably usurp the .apw NetLinx
+Studio workspace extension.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:is_a_workspace</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Set to true if this ExtensionHandler is for compiling a workspace. False by
+default. This parameter assists with smart compiling, as
+<span class='object_link'><a href="ExtensionDiscovery.html" title="NetLinx::Compile::ExtensionDiscovery (class)">NetLinx::Compile::ExtensionDiscovery</a></span> can return all workspace_handlers.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:handler_class</span>
+          <span class="type">(<tt><span class='object_link'><a href="Extension.html" title="NetLinx::Compile::Extension (module)">Extension</a></span></tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>A reference to the class that should be instantiated if this handler is
+selected. For example, <span class='object_link'><a href="../SourceFile.html" title="NetLinx::SourceFile (class)">SourceFile</a></span> is the class that handles
+files with the .axs extension.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
+35
+36
 37
 38
 39
-40
-41
-42</pre>
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 37</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 35</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'>@extensions</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'>:extensions</span><span class='comma'>,</span>     <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='ivar'>@usurps</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'>:usurps</span><span class='comma'>,</span>         <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='ivar'>@is_a_workspace</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'>:is_a_workspace</span><span class='comma'>,</span> <span class='kw'>false</span>
-  <span class='ivar'>@handler_class</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'>:handler_class</span><span class='comma'>,</span>  <span class='kw'>nil</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'>@extensions</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'>:extensions</span><span class='comma'>,</span>     <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@usurps</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'>:usurps</span><span class='comma'>,</span>         <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@is_a_workspace</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'>:is_a_workspace</span><span class='comma'>,</span> <span class='kw'>false</span>
+  <span class='ivar'>@handler_class</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'>:handler_class</span><span class='comma'>,</span>  <span class='kw'>nil</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>
@@ -556,16 +625,16 @@
   <tr>
     <td>
       <pre class="lines">
 
 
-45
-46
-47</pre>
+43
+44
+45</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 43</span>
 
 <span class='kw'>def</span> <span class='op'>&lt;&lt;</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
   <span class='ivar'>@extensions</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_parse_extension'>parse_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -583,11 +652,11 @@
 
   
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns true if this ExtensionHandler can handle the specified file
+<p>Returns true if this <span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">NetLinx::Compile::ExtensionHandler</a></span> can handle the specified file
 extension.</p>
 
 
   </div>
 </div>
@@ -611,16 +680,16 @@
   <tr>
     <td>
       <pre class="lines">
 
 
-64
-65
-66</pre>
+62
+63
+64</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 62</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
   <span class='ivar'>@extensions</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_parse_extension'>parse_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -638,13 +707,10 @@
 
   
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns true if the ExtensionHandler handles a workspace file (as opposed
-to a source code file).</p>
-
 <p>Workspace files are significant because they contain information about a
 project, connection settings for a master, and possibly multiple systems
 that need to be compiled. Therefore, when smart-compiling, workspaces need
 to be distinguished from source code files because discovering a workspace
 should be considered a better match than discovering a source code file.</p>
@@ -662,26 +728,32 @@
       
         <span class='type'>(<tt>Boolean</tt>)</span>
       
       
       
+        &mdash;
+        <div class='inline'>
+<p>true if the <span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">NetLinx::Compile::ExtensionHandler</a></span> handles a workspace file (as opposed to a
+source code file).</p>
+</div>
+      
     </li>
   
 </ul>
 
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-58
-59
-60</pre>
+56
+57
+58</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 58</span>
+      <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 56</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_is_a_workspace?'>is_a_workspace?</span>
   <span class='ivar'>@is_a_workspace</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -692,10 +764,10 @@
   </div>
 
 </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>
 
   </body>
\ No newline at end of file