netlinx-compile 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3d852b0d08c54dd00e2c320972b535787a61a3da
-  data.tar.gz: c73b7ccc4378daa417e859949b09cd3b30af461b
+SHA256:
+  metadata.gz: 070bead5068bd6344d281e4310fa5c8b0a73aa14edd370979d2f26533c820766
+  data.tar.gz: 63b6c36466a42c73f8aab382daa5df89090340d4e49ecb5df2f705d423b683d9
 SHA512:
-  metadata.gz: ae1c86c12eef2118253254ec8eb4395c6489f0eea5afca55c0c1649fc053c186d5a2a9d7c25da896f31407e4a03426baa4f0e4fcf5b24c0748ce65db54364848
-  data.tar.gz: e5f62bf0865b8c330b0d95f90b77202e7db33c5560e41cdc09bab4ef8d309dccc07705988f9a0fd9f6b67b6f7dd696c11066fb8f6e5bf7078ab6fa9d09378a59
+  metadata.gz: 10927c4db370d334a27fb6d339557c5752544b460d67e435f439364308b3270ca676ce133f7447d428f4570eabe7f4759fb63902673f06562bed65f05d69d3b4
+  data.tar.gz: dd28630c197c1d6dd642c91f4ce8a7021fd73b196430bf24526c8684a4f21ff1b15bf823a7c1c76c2fffd3b3394f20d920937ded45df7b53d9bd85769172207e

data/README.md

@@ -5,6 +5,8 @@ netlinx-compile
 A wrapper utility for the AMX NetLinx compiler.
 
 [![Gem Version](https://badge.fury.io/rb/netlinx-compile.png)](http://badge.fury.io/rb/netlinx-compile)
+[![API Documentation](https://img.shields.io/badge/docs-api-blue.svg)](http://www.rubydoc.info/gems/netlinx-compile)
+[![Apache 2.0 License](https://img.shields.io/badge/license-Apache%202.0-yellowgreen.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
 This library provides an executable, `netlinx-compile`, that wraps the `nlrc.exe`
 NetLinx compiler provided by AMX. It is designed for easier command line access,
@@ -20,10 +22,11 @@ AMX has broken NetLinx compilier functionality between NLRC.exe v1.0
 NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4 versions
 less than 4.1.1204, and has major problems. It is recommended to *avoid*
 NLRC.exe v2.x. NLRC.exe v3.x started being distributed in NetLinx Studio
-v4.1.1204 and appears to have fixed the problems when compiling include and Duet
-files. Due to the major changes in the NetLinx compiler, it may be necessary
-to use version 1.x of netlinx-compile when working with projects created with
-NetLinx Studio v3.x or earlier.
+v4.1.1204 and appears to have [fixed the problems when compiling include and
+Duet files](https://github.com/amclain/netlinx-compile/issues/1). Due to the
+major changes in the NetLinx compiler, it may be necessary to use version 1.x of
+netlinx-compile when working with projects created with NetLinx Studio v3.x or
+earlier.
 
 * Version 1.x of netlinx-compile targets NLRC.exe v1.x.
 * NLRC.exe v2.x is considered broken and is unsupported by netlinx-compile.
@@ -32,6 +35,88 @@ NetLinx Studio v3.x or earlier.
 [AMX NetLinx Compiler Bug List](https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix)
 
 
-## Documentation
+## Installation
 
-[https://sourceforge.net/p/netlinx-compile/wiki/Home/](https://sourceforge.net/p/netlinx-compile/wiki/Home/)
+netlinx-compile is available as a Ruby gem.
+
+1. Install [Ruby](http://www.ruby-lang.org/en/downloads/) 2.0 or higher
+(For Windows use [RubyInstaller](http://rubyinstaller.org/downloads/) and make
+sure ruby/bin is in your [system path](http://www.computerhope.com/issues/ch000549.htm).)
+2. Open the [command line](http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/) and type:
+
+``` text
+    gem install netlinx-compile
+    gem install netlinx-workspace (optional: for NetLinx Studio workspace support)
+```
+
+*NOTE: The NetLinx compiler executable provided by AMX, nlrc.exe, must be
+installed on your computer for this utility to work. It is included in the
+NetLinx Studio installation by default.*
+
+**If you receive the following error when running gem install:**
+`Unable to download data from https://rubygems.org/ - SSL_connect returned=1`
+
+Follow this guide:
+[Workaround RubyGems' SSL errors on Ruby for Windows (RubyInstaller)](https://gist.github.com/luislavena/f064211759ee0f806c88)
+
+
+## Issues, Bugs, Feature Requests
+
+Any bugs and feature requests should be reported on the GitHub issue tracker:
+
+https://github.com/amclain/netlinx-compile/issues
+
+
+**Pull requests are preferred via GitHub.**
+
+## Use
+
+**Sublime Text Editor**
+
+NetLinx Compile can be integrated into [Sublime Text](http://www.sublimetext.com/3)
+with the [Sublime Text AMX NetLinx Plugin](https://github.com/amclain/sublime-netlinx). This allows NetLinx source code and workspaces to be compiled with the editor's built-in build commands.
+
+
+**Command Line**
+
+NetLinx Compile provides friendlier command line access than the traditional
+NetLinx compiler provided by AMX. For starters, files can now be entered by
+relative path (`my_file.axs`) as well as absolute path (`c:\path\to\my_file.axs`).
+A more advanced feature, workspace compiling, can invoke the NetLinx compiler on
+a workspace file, as well as intelligently seek out a workspace for a given
+source code file.
+
+
+Compile a source code file.
+
+    netlinx-compile -s my_source_code.axs
+    
+Compile a workspace (with [NetLinx Workspace](https://github.com/amclain/netlinx-workspace)
+installed).
+
+    netlinx-compile -s my_workspace.apw
+
+Find the workspace that contains my_source_code.axs and compile it.
+
+    netlinx-compile -w -s my_source_code.axs
+
+Print all of the option flags and their descriptions.
+
+    netlinx-compile -h
+
+
+**Ruby Developer API**
+
+A Ruby API is provided for developers looking to integrate the NetLinx Compile
+library into thier own tools.
+[NetLinx Compile Developer Documentation](http://rubydoc.info/gems/netlinx-compile/frames)
+
+NetLinx Compile supports the ability to invoke the compiler on third-party
+files, like when creating new types of workspaces. To add NetLinx Compile
+support to your Ruby gem, create a handler for your file extension under the
+namespace NetLinx::Compile::Extension, place the .rb file under
+lib/netlinx/compile/extension in your gem, and add a dependency or development
+dependency in your gemspec to the netlinx-compile gem. NetLinx Compile will now
+automatically use your gem to compile the file extension it specifies. This is
+implemented in NetLinx::Compile::Extension::AXS, as well as in the
+[NetLinx Workspace](https://github.com/amclain/netlinx-workspace) gem.

data/doc/NetLinx.html

@@ -6,15 +6,15 @@
 <title>
   Module: NetLinx
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "NetLinx";
   relpath = '';
 </script>
@@ -120,9 +120,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 13 21:36:33 2018 by
+  Generated on Sat Jul 11 17:29:50 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.1.8).
+  0.9.25 (ruby-2.7.1).
 </div>
 
     </div>

data/doc/NetLinx/Compile.html

@@ -6,15 +6,15 @@
 <title>
   Module: NetLinx::Compile
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "NetLinx::Compile";
   relpath = '../';
 </script>
@@ -120,9 +120,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 13 21:36:33 2018 by
+  Generated on Sat Jul 11 17:29:50 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.1.8).
+  0.9.25 (ruby-2.7.1).
 </div>
 
     </div>

data/doc/NetLinx/Compile/Extension.html

@@ -6,15 +6,15 @@
 <title>
   Module: NetLinx::Compile::Extension
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "NetLinx::Compile::Extension";
   relpath = '../../';
 </script>
@@ -118,9 +118,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 13 21:36:33 2018 by
+  Generated on Sat Jul 11 17:29:50 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.1.8).
+  0.9.25 (ruby-2.7.1).
 </div>
 
     </div>

data/doc/NetLinx/Compile/Extension/AXS.html

@@ -6,15 +6,15 @@
 <title>
   Class: NetLinx::Compile::Extension::AXS
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "NetLinx::Compile::Extension::AXS";
   relpath = '../../../';
 </script>
@@ -208,9 +208,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 13 21:36:33 2018 by
+  Generated on Sat Jul 11 17:29:51 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.1.8).
+  0.9.25 (ruby-2.7.1).
 </div>
 
     </div>

data/doc/NetLinx/Compile/ExtensionDiscovery.html

@@ -6,15 +6,15 @@
 <title>
   Class: NetLinx::Compile::ExtensionDiscovery
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "NetLinx::Compile::ExtensionDiscovery";
   relpath = '../../';
 </script>
@@ -248,8 +248,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>An array of ExtensionHandlers installed on the system. #discover must be
-run before this array is populated.</p>
+<p>An array of ExtensionHandlers installed on the system. #discover must be run before this array is populated.</p>
 
 
   </div>
@@ -297,9 +296,7 @@ run before this array is populated.
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Searches for gems with &#39;netlinx-compile&#39; as a dependency. The
-&#39;lib/netlinx/compile/extension/*&#39; path is checked for compiler
-extensions.</p>
+<p>Searches for gems with &#39;netlinx-compile&#39; as a dependency. The &#39;lib/netlinx/compile/extension/*&#39; path is checked for compiler extensions.</p>
 
 
   </div>
@@ -353,10 +350,10 @@ extensions.
   <span class='id identifier rubyid_nc_gem_files'>nc_gem_files</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span> <span class='id identifier rubyid_require'>require</span> <span class='id identifier rubyid_file'>file</span><span class='rbrace'>}</span>
   
   <span class='comment'># Find gems with a dependency on &#39;netlinx-compile&#39;.
-</span>  <span class='id identifier rubyid_gems'>gems</span> <span class='op'>=</span> <span class='const'>Gem</span><span class='op'>::</span><span class='const'>Specification</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='period'>
-</span><span class='id identifier rubyid_    .select'>    .select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_gem'>gem</span><span class='op'>|</span> <span class='id identifier rubyid_gem'>gem</span><span class='period'>.</span><span class='id identifier rubyid_dependencies'>dependencies</span><span class='period'>
-</span><span class='id identifier rubyid_      .select'>      .select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_dependency'>dependency</span><span class='op'>|</span> <span class='id identifier rubyid_dependency'>dependency</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netlinx-compile</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>
-</span><span class='id identifier rubyid_      .empty?'>      .empty?</span> <span class='op'>==</span> <span class='kw'>false</span>
+</span>  <span class='id identifier rubyid_gems'>gems</span> <span class='op'>=</span> <span class='const'>Gem</span><span class='op'>::</span><span class='const'>Specification</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span>
+    <span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_gem'>gem</span><span class='op'>|</span> <span class='id identifier rubyid_gem'>gem</span><span class='period'>.</span><span class='id identifier rubyid_dependencies'>dependencies</span>
+      <span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_dependency'>dependency</span><span class='op'>|</span> <span class='id identifier rubyid_dependency'>dependency</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netlinx-compile</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span>
+      <span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>==</span> <span class='kw'>false</span>
     <span class='rbrace'>}</span>
   
   <span class='comment'># Load any Ruby files in their lib/netlinx/compile/extension paths.
@@ -367,11 +364,11 @@ extensions.
   <span class='kw'>end</span>
   
   <span class='comment'># Register ExtensionHandler objects.
-</span>  <span class='ivar'>@handlers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Compile.html" title="NetLinx::Compile (module)">Compile</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Extension.html" title="NetLinx::Compile::Extension (module)">Extension</a></span></span><span class='period'>.</span><span class='id identifier rubyid_constants'>constants</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_c'>c</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Compile.html" title="NetLinx::Compile (module)">Compile</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Extension.html" title="NetLinx::Compile::Extension (module)">Extension</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span> <span class='id identifier rubyid_c'>c</span><span class='rbrace'>}</span><span class='period'>
-</span><span class='id identifier rubyid_    .select'>    .select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Class</span><span class='rbrace'>}</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_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_get_handler'>get_handler</span> <span class='kw'>if</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span> <span class='symbol'>:get_handler</span><span class='rbrace'>}</span><span class='period'>
-</span><span class='id identifier rubyid_    .select'>    .select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='kw'>not</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span><span class='rbrace'>}</span>
+</span>  <span class='ivar'>@handlers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Compile.html" title="NetLinx::Compile (module)">Compile</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Extension.html" title="NetLinx::Compile::Extension (module)">Extension</a></span></span><span class='period'>.</span><span class='id identifier rubyid_constants'>constants</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_c'>c</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Compile.html" title="NetLinx::Compile (module)">Compile</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Extension.html" title="NetLinx::Compile::Extension (module)">Extension</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span> <span class='id identifier rubyid_c'>c</span><span class='rbrace'>}</span>
+    <span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Class</span><span class='rbrace'>}</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_c'>c</span><span class='op'>|</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_get_handler'>get_handler</span> <span class='kw'>if</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span> <span class='symbol'>:get_handler</span><span class='rbrace'>}</span>
+    <span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='kw'>not</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span><span class='rbrace'>}</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -505,10 +502,10 @@ extensions.
       <pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_discovery.rb', line 47</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_workspace_extensions'>workspace_extensions</span>
-  <span class='ivar'>@handlers</span><span class='period'>
-</span><span class='id identifier rubyid_    .select'>    .select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_h'>h</span><span class='op'>|</span> <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_is_a_workspace?'>is_a_workspace?</span><span class='rbrace'>}</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_h'>h</span><span class='op'>|</span> <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_extensions'>extensions</span><span class='rbrace'>}</span><span class='period'>
-</span><span class='id identifier rubyid_    .flatten'>    .flatten</span>
+  <span class='ivar'>@handlers</span>
+    <span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_h'>h</span><span class='op'>|</span> <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_is_a_workspace?'>is_a_workspace?</span><span class='rbrace'>}</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_h'>h</span><span class='op'>|</span> <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_extensions'>extensions</span><span class='rbrace'>}</span>
+    <span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -520,9 +517,9 @@ extensions.
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 13 21:36:34 2018 by
+  Generated on Sat Jul 11 17:29:51 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.1.8).
+  0.9.25 (ruby-2.7.1).
 </div>
 
     </div>

data/doc/NetLinx/Compile/ExtensionHandler.html

@@ -6,15 +6,15 @@
 <title>
   Class: NetLinx::Compile::ExtensionHandler
   
-    &mdash; Documentation by YARD 0.9.12
+    &mdash; Documentation by YARD 0.9.25
   
 </title>
 
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "NetLinx::Compile::ExtensionHandler";
   relpath = '../../';
 </script>
@@ -102,8 +102,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Tells netlinx-compile which class handles the compiling of a set of file
-extensions.</p>
+<p>Tells netlinx-compile which class handles the compiling of a set of file extensions.</p>
 
 
   </div>
@@ -168,8 +167,7 @@ extensions.
 
   
     <span class="summary_desc"><div class='inline'>
-<p>The class to invoke to handle compiling a file extension specified in this
-ExtensionHandler.</p>
+<p>The class to invoke to handle compiling a file extension specified in this ExtensionHandler.</p>
 </div></span>
   
 </li>
@@ -257,8 +255,7 @@ ExtensionHandler.
 
   
     <span class="summary_desc"><div class='inline'>
-<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>
+<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>
@@ -308,9 +305,7 @@ extension.
 
   
     <span class="summary_desc"><div class='inline'>
-<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>
+<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>
@@ -334,7 +329,7 @@ that need to be compiled.
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns a new instance of ExtensionHandler</p>
+<p>Returns a new instance of ExtensionHandler.</p>
 
 
   </div>
@@ -375,8 +370,7 @@ that need to be compiled.
           </span>
           
             &mdash; <div class='inline'>
-<p>File extensions (without the leading dot) that this ExtensionHandler
-supports.</p>
+<p>File extensions (without the leading dot) that this ExtensionHandler supports.</p>
 </div>
           
         </li>
@@ -389,9 +383,7 @@ supports.
           </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>
+<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>
@@ -404,9 +396,7 @@ Studio workspace extension.
           </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>
+<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>
@@ -419,9 +409,7 @@ default. This parameter assists with smart compiling, as
           </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>
+<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>
@@ -519,8 +507,7 @@ files with the .axs extension.
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>The class to invoke to handle compiling a file extension specified in this
-ExtensionHandler.</p>
+<p>The class to invoke to handle compiling a file extension specified in this ExtensionHandler.</p>
 
 
   </div>
@@ -563,9 +550,7 @@ ExtensionHandler.
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>A list of file extensions that this ExtensionHandler usurps. For example,
-third-party workspace extensions would probably usurp the .apw workspace
-extension.</p>
+<p>A list of file extensions that this ExtensionHandler usurps. For example, third-party workspace extensions would probably usurp the .apw workspace extension.</p>
 
 
   </div>
@@ -654,8 +639,7 @@ extension.
 </h3><div class="docstring">
   <div class="discussion">
     
-<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>
+<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>
@@ -709,11 +693,7 @@ extension.
 </h3><div class="docstring">
   <div class="discussion">
     
-<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>
+<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>
 
 
   </div>
@@ -732,8 +712,7 @@ should be considered a better match than discovering a source code file.
       
         &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>
+<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>
@@ -766,9 +745,9 @@ source code file).
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 13 21:36:34 2018 by
+  Generated on Sat Jul 11 17:29:51 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.1.8).
+  0.9.25 (ruby-2.7.1).
 </div>
 
     </div>