Added docs and publish command

Added documentation
glayzzle · Aug 15, 2018 · ebbf320 · ebbf320
1 parent d10921c
commit ebbf320
Show file tree

Hide file tree

Showing 247 changed files with 89,883 additions and 1,670 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,4 @@
 /npm-debug.log
 /nbproject
 /coverage
-/docs
 *.swp
diff --git a/docs/AST.html b/docs/AST.html
diff --git a/docs/Array.html b/docs/Array.html
diff --git a/docs/Assign.html b/docs/Assign.html
diff --git a/docs/Bin.html b/docs/Bin.html
diff --git a/docs/Block.html b/docs/Block.html
diff --git a/docs/Boolean.html b/docs/Boolean.html
diff --git a/docs/Break.html b/docs/Break.html
diff --git a/docs/Call.html b/docs/Call.html
diff --git a/docs/Case.html b/docs/Case.html
diff --git a/docs/Cast.html b/docs/Cast.html
diff --git a/docs/Catch.html b/docs/Catch.html
diff --git a/docs/Class.html b/docs/Class.html
diff --git a/docs/ClassConstant.html b/docs/ClassConstant.html
diff --git a/docs/Clone.html b/docs/Clone.html
diff --git a/docs/Closure.html b/docs/Closure.html
diff --git a/docs/Comment.html b/docs/Comment.html
diff --git a/docs/CommentBlock.html b/docs/CommentBlock.html
diff --git a/docs/CommentLine.html b/docs/CommentLine.html
diff --git a/docs/ConstRef.html b/docs/ConstRef.html
diff --git a/docs/Constant.html b/docs/Constant.html
diff --git a/docs/Continue.html b/docs/Continue.html
diff --git a/docs/Declaration.html b/docs/Declaration.html
diff --git a/docs/Declare.html b/docs/Declare.html
diff --git a/docs/Do.html b/docs/Do.html
diff --git a/docs/Echo.html b/docs/Echo.html
diff --git a/docs/Empty.html b/docs/Empty.html
diff --git a/docs/Encapsed.html b/docs/Encapsed.html
diff --git a/docs/Entry.html b/docs/Entry.html
diff --git a/docs/Error.html b/docs/Error.html
diff --git a/docs/Eval.html b/docs/Eval.html
diff --git a/docs/Exit.html b/docs/Exit.html
diff --git a/docs/Expression.html b/docs/Expression.html
diff --git a/docs/For.html b/docs/For.html
diff --git a/docs/Foreach.html b/docs/Foreach.html
diff --git a/docs/Function.html b/docs/Function.html
diff --git a/docs/Global_.html b/docs/Global_.html
diff --git a/docs/Goto.html b/docs/Goto.html
diff --git a/docs/Halt.html b/docs/Halt.html
diff --git a/docs/Identifier.html b/docs/Identifier.html
diff --git a/docs/If.html b/docs/If.html
diff --git a/docs/Include.html b/docs/Include.html
diff --git a/docs/Inline.html b/docs/Inline.html
diff --git a/docs/Interface.html b/docs/Interface.html
diff --git a/docs/Isset.html b/docs/Isset.html
diff --git a/docs/Label.html b/docs/Label.html
diff --git a/docs/List.html b/docs/List.html
diff --git a/docs/Literal.html b/docs/Literal.html
diff --git a/docs/Location.html b/docs/Location.html
diff --git a/docs/Lookup.html b/docs/Lookup.html
diff --git a/docs/Magic.html b/docs/Magic.html
diff --git a/docs/Method.html b/docs/Method.html
diff --git a/docs/Namespace.html b/docs/Namespace.html
diff --git a/docs/New.html b/docs/New.html
diff --git a/docs/Node.html b/docs/Node.html
diff --git a/docs/Number.html b/docs/Number.html
diff --git a/docs/OffsetLookup.html b/docs/OffsetLookup.html
diff --git a/docs/Operation.html b/docs/Operation.html
diff --git a/docs/Parameter.html b/docs/Parameter.html
diff --git a/docs/Parenthesis.html b/docs/Parenthesis.html
diff --git a/docs/Position.html b/docs/Position.html
diff --git a/docs/Post.html b/docs/Post.html
diff --git a/docs/Pre.html b/docs/Pre.html
diff --git a/docs/Print.html b/docs/Print.html
diff --git a/docs/Program.html b/docs/Program.html
diff --git a/docs/Property.html b/docs/Property.html
diff --git a/docs/PropertyLookup.html b/docs/PropertyLookup.html
diff --git a/docs/RetIf.html b/docs/RetIf.html
diff --git a/docs/Return.html b/docs/Return.html
diff --git a/docs/Silent.html b/docs/Silent.html
diff --git a/docs/Statement.html b/docs/Statement.html
diff --git a/docs/Static.html b/docs/Static.html
diff --git a/docs/StaticLookup.html b/docs/StaticLookup.html
diff --git a/docs/String.html b/docs/String.html
diff --git a/docs/Switch.html b/docs/Switch.html
diff --git a/docs/Sys.html b/docs/Sys.html
diff --git a/docs/Throw.html b/docs/Throw.html
diff --git a/docs/Trait.html b/docs/Trait.html
diff --git a/docs/TraitAlias.html b/docs/TraitAlias.html
diff --git a/docs/TraitPrecedence.html b/docs/TraitPrecedence.html
diff --git a/docs/TraitUse.html b/docs/TraitUse.html
diff --git a/docs/Try.html b/docs/Try.html
diff --git a/docs/Unary.html b/docs/Unary.html
diff --git a/docs/Unset.html b/docs/Unset.html
diff --git a/docs/UseGroup.html b/docs/UseGroup.html
diff --git a/docs/UseItem.html b/docs/UseItem.html
diff --git a/docs/Variable.html b/docs/Variable.html
diff --git a/docs/While.html b/docs/While.html
diff --git a/docs/Yield.html b/docs/Yield.html
diff --git a/docs/YieldFrom.html b/docs/YieldFrom.html
diff --git a/docs/ast.js.html b/docs/ast.js.html
diff --git a/docs/ast_array.js.html b/docs/ast_array.js.html
diff --git a/docs/ast_assign.js.html b/docs/ast_assign.js.html
diff --git a/docs/ast_bin.js.html b/docs/ast_bin.js.html
diff --git a/docs/ast_block.js.html b/docs/ast_block.js.html
diff --git a/docs/ast_boolean.js.html b/docs/ast_boolean.js.html
diff --git a/docs/ast_break.js.html b/docs/ast_break.js.html
diff --git a/docs/ast_call.js.html b/docs/ast_call.js.html
diff --git a/docs/ast_case.js.html b/docs/ast_case.js.html
diff --git a/docs/ast_cast.js.html b/docs/ast_cast.js.html
diff --git a/docs/ast_catch.js.html b/docs/ast_catch.js.html
diff --git a/docs/ast_class.js.html b/docs/ast_class.js.html
diff --git a/docs/ast_classconstant.js.html b/docs/ast_classconstant.js.html
diff --git a/docs/ast_clone.js.html b/docs/ast_clone.js.html
diff --git a/docs/ast_closure.js.html b/docs/ast_closure.js.html
diff --git a/docs/ast_comment.js.html b/docs/ast_comment.js.html
diff --git a/docs/ast_commentblock.js.html b/docs/ast_commentblock.js.html
diff --git a/docs/ast_commentline.js.html b/docs/ast_commentline.js.html
diff --git a/docs/ast_constant.js.html b/docs/ast_constant.js.html
diff --git a/docs/ast_constref.js.html b/docs/ast_constref.js.html
diff --git a/docs/ast_continue.js.html b/docs/ast_continue.js.html
diff --git a/docs/ast_declaration.js.html b/docs/ast_declaration.js.html
diff --git a/docs/ast_declare.js.html b/docs/ast_declare.js.html
diff --git a/docs/ast_do.js.html b/docs/ast_do.js.html
diff --git a/docs/ast_echo.js.html b/docs/ast_echo.js.html
diff --git a/docs/ast_empty.js.html b/docs/ast_empty.js.html
diff --git a/docs/ast_encapsed.js.html b/docs/ast_encapsed.js.html
diff --git a/docs/ast_entry.js.html b/docs/ast_entry.js.html
diff --git a/docs/ast_error.js.html b/docs/ast_error.js.html
diff --git a/docs/ast_eval.js.html b/docs/ast_eval.js.html
diff --git a/docs/ast_exit.js.html b/docs/ast_exit.js.html
diff --git a/docs/ast_expression.js.html b/docs/ast_expression.js.html
diff --git a/docs/ast_for.js.html b/docs/ast_for.js.html
diff --git a/docs/ast_foreach.js.html b/docs/ast_foreach.js.html
diff --git a/docs/ast_function.js.html b/docs/ast_function.js.html
diff --git a/docs/ast_global.js.html b/docs/ast_global.js.html
diff --git a/docs/ast_goto.js.html b/docs/ast_goto.js.html
diff --git a/docs/ast_halt.js.html b/docs/ast_halt.js.html
diff --git a/docs/ast_identifier.js.html b/docs/ast_identifier.js.html
diff --git a/docs/ast_if.js.html b/docs/ast_if.js.html
diff --git a/docs/ast_include.js.html b/docs/ast_include.js.html
diff --git a/docs/ast_inline.js.html b/docs/ast_inline.js.html
diff --git a/docs/ast_interface.js.html b/docs/ast_interface.js.html
diff --git a/docs/ast_isset.js.html b/docs/ast_isset.js.html
diff --git a/docs/ast_label.js.html b/docs/ast_label.js.html
diff --git a/docs/ast_list.js.html b/docs/ast_list.js.html
diff --git a/docs/ast_literal.js.html b/docs/ast_literal.js.html
diff --git a/docs/ast_location.js.html b/docs/ast_location.js.html
diff --git a/docs/ast_lookup.js.html b/docs/ast_lookup.js.html
diff --git a/docs/ast_magic.js.html b/docs/ast_magic.js.html
diff --git a/docs/ast_method.js.html b/docs/ast_method.js.html
diff --git a/docs/ast_namespace.js.html b/docs/ast_namespace.js.html
diff --git a/docs/ast_new.js.html b/docs/ast_new.js.html
diff --git a/docs/ast_node.js.html b/docs/ast_node.js.html
diff --git a/docs/ast_nowdoc.js.html b/docs/ast_nowdoc.js.html
diff --git a/docs/ast_number.js.html b/docs/ast_number.js.html
diff --git a/docs/ast_offsetlookup.js.html b/docs/ast_offsetlookup.js.html
diff --git a/docs/ast_operation.js.html b/docs/ast_operation.js.html
diff --git a/docs/ast_parameter.js.html b/docs/ast_parameter.js.html
diff --git a/docs/ast_parenthesis.js.html b/docs/ast_parenthesis.js.html
diff --git a/docs/ast_position.js.html b/docs/ast_position.js.html
diff --git a/docs/ast_post.js.html b/docs/ast_post.js.html
diff --git a/docs/ast_pre.js.html b/docs/ast_pre.js.html
diff --git a/docs/ast_print.js.html b/docs/ast_print.js.html
diff --git a/docs/ast_program.js.html b/docs/ast_program.js.html
diff --git a/docs/ast_property.js.html b/docs/ast_property.js.html
diff --git a/docs/ast_propertylookup.js.html b/docs/ast_propertylookup.js.html
diff --git a/docs/ast_retif.js.html b/docs/ast_retif.js.html
diff --git a/docs/ast_return.js.html b/docs/ast_return.js.html
diff --git a/docs/ast_silent.js.html b/docs/ast_silent.js.html
diff --git a/docs/ast_statement.js.html b/docs/ast_statement.js.html
diff --git a/docs/ast_static.js.html b/docs/ast_static.js.html
diff --git a/docs/ast_staticlookup.js.html b/docs/ast_staticlookup.js.html
diff --git a/docs/ast_string.js.html b/docs/ast_string.js.html
diff --git a/docs/ast_switch.js.html b/docs/ast_switch.js.html
diff --git a/docs/ast_sys.js.html b/docs/ast_sys.js.html
diff --git a/docs/ast_throw.js.html b/docs/ast_throw.js.html
diff --git a/docs/ast_trait.js.html b/docs/ast_trait.js.html
diff --git a/docs/ast_traitalias.js.html b/docs/ast_traitalias.js.html
diff --git a/docs/ast_traitprecedence.js.html b/docs/ast_traitprecedence.js.html
diff --git a/docs/ast_traituse.js.html b/docs/ast_traituse.js.html
diff --git a/docs/ast_try.js.html b/docs/ast_try.js.html
diff --git a/docs/ast_unary.js.html b/docs/ast_unary.js.html
diff --git a/docs/ast_unset.js.html b/docs/ast_unset.js.html
diff --git a/docs/ast_usegroup.js.html b/docs/ast_usegroup.js.html
diff --git a/docs/ast_useitem.js.html b/docs/ast_useitem.js.html
diff --git a/docs/ast_variable.js.html b/docs/ast_variable.js.html
diff --git a/docs/ast_variadic.js.html b/docs/ast_variadic.js.html
diff --git a/docs/ast_while.js.html b/docs/ast_while.js.html
diff --git a/docs/ast_yield.js.html b/docs/ast_yield.js.html
diff --git a/docs/ast_yieldfrom.js.html b/docs/ast_yieldfrom.js.html
diff --git a/docs/engine.html b/docs/engine.html
diff --git a/docs/fonts/OpenSans-Bold-webfont.eot b/docs/fonts/OpenSans-Bold-webfont.eot
diff --git a/docs/fonts/OpenSans-Bold-webfont.svg b/docs/fonts/OpenSans-Bold-webfont.svg
diff --git a/docs/fonts/OpenSans-Bold-webfont.woff b/docs/fonts/OpenSans-Bold-webfont.woff
diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.eot b/docs/fonts/OpenSans-BoldItalic-webfont.eot
diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.svg b/docs/fonts/OpenSans-BoldItalic-webfont.svg
diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.woff b/docs/fonts/OpenSans-BoldItalic-webfont.woff
diff --git a/docs/fonts/OpenSans-Italic-webfont.eot b/docs/fonts/OpenSans-Italic-webfont.eot
diff --git a/docs/fonts/OpenSans-Italic-webfont.svg b/docs/fonts/OpenSans-Italic-webfont.svg
diff --git a/docs/fonts/OpenSans-Italic-webfont.woff b/docs/fonts/OpenSans-Italic-webfont.woff
diff --git a/docs/fonts/OpenSans-Light-webfont.eot b/docs/fonts/OpenSans-Light-webfont.eot
diff --git a/docs/fonts/OpenSans-Light-webfont.svg b/docs/fonts/OpenSans-Light-webfont.svg
diff --git a/docs/fonts/OpenSans-Light-webfont.woff b/docs/fonts/OpenSans-Light-webfont.woff
diff --git a/docs/fonts/OpenSans-LightItalic-webfont.eot b/docs/fonts/OpenSans-LightItalic-webfont.eot
diff --git a/docs/fonts/OpenSans-LightItalic-webfont.svg b/docs/fonts/OpenSans-LightItalic-webfont.svg
diff --git a/docs/fonts/OpenSans-LightItalic-webfont.woff b/docs/fonts/OpenSans-LightItalic-webfont.woff
diff --git a/docs/fonts/OpenSans-Regular-webfont.eot b/docs/fonts/OpenSans-Regular-webfont.eot
diff --git a/docs/fonts/OpenSans-Regular-webfont.svg b/docs/fonts/OpenSans-Regular-webfont.svg
diff --git a/docs/fonts/OpenSans-Regular-webfont.woff b/docs/fonts/OpenSans-Regular-webfont.woff
diff --git a/docs/fonts/OpenSans-Semibold-webfont.eot b/docs/fonts/OpenSans-Semibold-webfont.eot
diff --git a/docs/fonts/OpenSans-Semibold-webfont.svg b/docs/fonts/OpenSans-Semibold-webfont.svg
diff --git a/docs/fonts/OpenSans-Semibold-webfont.ttf b/docs/fonts/OpenSans-Semibold-webfont.ttf
diff --git a/docs/fonts/OpenSans-Semibold-webfont.woff b/docs/fonts/OpenSans-Semibold-webfont.woff
diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.eot b/docs/fonts/OpenSans-SemiboldItalic-webfont.eot
diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.svg b/docs/fonts/OpenSans-SemiboldItalic-webfont.svg
diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf b/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf
diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.woff b/docs/fonts/OpenSans-SemiboldItalic-webfont.woff
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/icons/home.svg b/docs/icons/home.svg
diff --git a/docs/icons/search.svg b/docs/icons/search.svg
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.js.html b/docs/index.js.html
diff --git a/docs/lexer.html b/docs/lexer.html
diff --git a/docs/lexer.js.html b/docs/lexer.js.html
diff --git a/docs/lexer_comments.js.html b/docs/lexer_comments.js.html
diff --git a/docs/lexer_strings.js.html b/docs/lexer_strings.js.html
diff --git a/docs/parser.html b/docs/parser.html
diff --git a/docs/parser.js.html b/docs/parser.js.html
diff --git a/docs/parser_array.js.html b/docs/parser_array.js.html
diff --git a/docs/parser_class.js.html b/docs/parser_class.js.html
diff --git a/docs/parser_comment.js.html b/docs/parser_comment.js.html
diff --git a/docs/parser_expr.js.html b/docs/parser_expr.js.html
diff --git a/docs/parser_function.js.html b/docs/parser_function.js.html
diff --git a/docs/parser_if.js.html b/docs/parser_if.js.html
diff --git a/docs/parser_loops.js.html b/docs/parser_loops.js.html
diff --git a/docs/parser_main.js.html b/docs/parser_main.js.html
diff --git a/docs/parser_namespace.js.html b/docs/parser_namespace.js.html
diff --git a/docs/parser_scalar.js.html b/docs/parser_scalar.js.html
diff --git a/docs/parser_statement.js.html b/docs/parser_statement.js.html
diff --git a/docs/parser_switch.js.html b/docs/parser_switch.js.html
diff --git a/docs/parser_try.js.html b/docs/parser_try.js.html
diff --git a/docs/parser_utils.js.html b/docs/parser_utils.js.html
diff --git a/docs/parser_variable.js.html b/docs/parser_variable.js.html
diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js
@@ -0,0 +1,24 @@
+'use strict';
+
+/* global document */
+(function () {
+  var lineId, lines, totalLines, anchorHash;
+  var source = document.getElementsByClassName('prettyprint source linenums');
+  var i = 0;
+  var lineNumber = 0;
+
+  if (source && source[0]) {
+    anchorHash = document.location.hash.substring(1);
+    lines = source[0].getElementsByTagName('li');
+    totalLines = lines.length;
+
+    for (; i < totalLines; i++) {
+      lineNumber++;
+      lineId = 'line' + lineNumber;
+      lines[i].id = lineId;
+      if (lineId === anchorHash) {
+        lines[i].className += ' selected';
+      }
+    }
+  }
+})();
diff --git a/docs/scripts/pagelocation.js b/docs/scripts/pagelocation.js
@@ -0,0 +1,89 @@
+'use strict';
+
+$(document).ready(function () {
+  var currentSectionNav, target;
+
+  // If an anchor hash is in the URL highlight the menu item
+  highlightActiveHash();
+  // If a specific page section is in the URL highlight the menu item
+  highlightActiveSection();
+
+  // If a specific page section is in the URL scroll that section up to the top
+  currentSectionNav = $('#' + getCurrentSectionName() + '-nav');
+
+  if (currentSectionNav.position()) {
+    $('nav').scrollTop(currentSectionNav.position().top);
+  }
+
+  // function to scroll to anchor when clicking an anchor linl
+  $('a[href*="#"]:not([href="#"])').click(function () {
+    /* eslint-disable no-invalid-this */
+    if (location.pathname.replace(/^\//, '') === this.pathname.replace(/^\//, '') && location.hostname === this.hostname) {
+      target = $(this.hash);
+      target = target.length ? target : $('[name=' + this.hash.slice(1) + ']');
+      if (target.length) {
+        $('html, body').animate({
+          scrollTop: target.offset().top
+        }, 1000);
+      }
+    }
+    /* eslint-enable no-invalid-this */
+  });
+});
+
+// If a new anchor section is selected, change the hightlighted menu item
+$(window).bind('hashchange', function (event) {
+  highlightActiveHash(event);
+});
+
+function highlightActiveHash(event) {
+  var oldUrl, oldSubSectionElement;
+
+  // check for and remove old hash active state
+  if (event && event.originalEvent.oldURL) {
+    oldUrl = event.originalEvent.oldURL;
+
+    if (oldUrl.indexOf('#') > -1) {
+      oldSubSectionElement = $('#' + getCurrentSectionName() + '-' + oldUrl.substring(oldUrl.indexOf('#') + 1) + '-nav');
+
+      if (oldSubSectionElement) {
+        oldSubSectionElement.removeClass('active');
+      }
+    }
+  }
+
+  if (getCurrentHashName()) {
+    $('#' + getCurrentSectionName() + '-' + getCurrentHashName() + '-nav').addClass('active');
+  }
+}
+
+function highlightActiveSection() {
+  var pageId = getCurrentSectionName();
+
+  $('#' + pageId + '-nav').addClass('active');
+}
+
+function getCurrentSectionName() {
+  var path = window.location.pathname;
+  var pageUrl = path.split('/').pop();
+
+  var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
+
+  // remove the wodr module- if its in the url
+  sectionName = sectionName.replace('module-', '');
+
+  return sectionName;
+}
+
+function getCurrentHashName() {
+  var pageSubSectionId;
+  var pageSubSectionHash = window.location.hash;
+
+  if (pageSubSectionHash) {
+    pageSubSectionId = pageSubSectionHash.substring(1).replace('.', '');
+
+    return pageSubSectionId;
+  }
+
+  return false;
+}