+
-
+
- 
- 
- 
- 
- 
- 
-
- © 2019, Onur Yıldırım (@onury).
-
A powerful tool to easily generate beautiful HTML documentation from Javascript (JSDoc), Markdown and HTML files.
-
...like this:
-
- 
-
-
- This is generated with the built-in template, Zebra.
- click to view live
-
npm i @jacekpietal/docma -D
-You can use Docma CLI to build documentations directly from your console.
-Once you create the configuration file docma.json in your project root, it's quite simple.
docma
-You can even serve the docs locally and test.
-docma serve
-See
-If you need to build documentation from within your code, use the API.
-const Docma = require("@jacekpietal/docma");
-Either by passing a configuration object.
-const config = {
- src: ["./code/**/*.js", "./README.md"],
- dest: "./output/doc",
-};
-Docma.create()
- .build(config)
- .then((success) => console.log("Documentation is built successfully."))
- .catch((error) => console.log(error));
-Or by reading configuration from a JSON file.
-Docma.create()
- .build("./path/to/docma.json")
- .catch((error) => console.log(error));
+The fork of the fork of the fork of the original Docma to update its deps.
+Install
+yarn add @qiwi/docma
-See Docma API Reference.
-Parsed Output
-
-Sometimes, the issue is with invalid JSDoc comments. See this for linting/validating your JSDoc while you type and within a build process.
-To investigate the parsed JSDoc output, enable the debug option that will create a JSON output(s) within the root of the destination directory. If you have a problem with the parsed documentation data, open an issue @ jsdoc-x. (I'm the author.)
-For markdown output issues (that are not related with style), you can open an issue @ marked.
-Changelog
-
-See CHANGELOG.
-Compatibility Table
-
-
-
-Docma version
-Node version
-
-
-
-v3.0.0
-v8+
-
-
-v2.0.0
-v6+
-
-
-v1.0.0
-v4+
-
-
-Documentation
-
-Read Docma documentation, built with Docma, for a Docma demo... 
Also see the [F.A.Q.][docma-faq] section.
-License
-
-MIT. You don't have to include any copyright notice in your documentation output or templates but I'd appreciate if you let people know about this tool so we can read better documentations.
-Emoji shortcuts used in source markdown files are parsed into twemoji. Graphics and icons licensed under CC-BY 4.0.
-Related Modules
-
-
-- jsdoc-x — Parser for outputting a Javascript object from documented code via JSDoc's explain (-X) command.
-- marked — A full-featured markdown parser and compiler, written in JavaScript. Built for speed.
-- dustjs — Asynchronous Javascript templating for the browser and server.
-
+Usage
+Follow the original docs.
+License
+
\ No newline at end of file
diff --git a/docs/content/readme.html b/docs/content/readme.html
index 180642d..99768c0 100644
--- a/docs/content/readme.html
+++ b/docs/content/readme.html
@@ -1,125 +1,14 @@
-
+
-
-
-
-
-
-
-
-
-
- © 2019, Onur Yıldırım (@onury).
-
-
-A powerful tool to easily generate beautiful HTML documentation from Javascript (JSDoc), Markdown and HTML files.
-Features
-
-
-- Parse JSDoc documentation, Markdown and HTML files.
-- Build a cool SPA (Single Page Application) from parsed files.
-- Generate multiple/separate API documentations by grouping JS files.
-- Path or Query-string based app routing.
-- Non-opinionated engine, built-in template with cool opinions.
-- Supports custom templates, comes with template authoring tools.
-- Works great with GitHub Pages, Amazon S3, Nginx, Apache, etc...
-- Build via API or CLI.
-- Extremely configurable and debuggable.
-- Well documented.
-
-...like this:
-
-
-
-
- This is generated with the built-in template, Zebra.
- click to view live
-
-
-Installation
-
-npm i @jacekpietal/docma -D
-
-Building Documentation with CLI
-
-You can use Docma CLI to build documentations directly from your console.
-Once you create the configuration file docma.json in your project root, it's quite simple.
-docma
-
-You can even serve the docs locally and test.
-docma serve
-
-See
-
-- Docma CLI Reference
-- Build Configuration
-- [F.A.Q.][docma-faq]
-
-Building Documentation Programmatically
-
-If you need to build documentation from within your code, use the API.
-const Docma = require("@jacekpietal/docma");
-
-Either by passing a configuration object.
-const config = {
- src: ["./code/**/*.js", "./README.md"],
- dest: "./output/doc",
-};
-Docma.create()
- .build(config)
- .then((success) => console.log("Documentation is built successfully."))
- .catch((error) => console.log(error));
-
-Or by reading configuration from a JSON file.
-Docma.create()
- .build("./path/to/docma.json")
- .catch((error) => console.log(error));
+The fork of the fork of the fork of the original Docma to update its deps.
+Install
+yarn add @qiwi/docma
-See Docma API Reference.
-Parsed Output
-
-Sometimes, the issue is with invalid JSDoc comments. See this for linting/validating your JSDoc while you type and within a build process.
-To investigate the parsed JSDoc output, enable the debug option that will create a JSON output(s) within the root of the destination directory. If you have a problem with the parsed documentation data, open an issue @ jsdoc-x. (I'm the author.)
-For markdown output issues (that are not related with style), you can open an issue @ marked.
-Changelog
-
-See CHANGELOG.
-Compatibility Table
-
-
-
-Docma version
-Node version
-
-
-
-v3.0.0
-v8+
-
-
-v2.0.0
-v6+
-
-
-v1.0.0
-v4+
-
-
-Documentation
-
-Read Docma documentation, built with Docma, for a Docma demo...
Also see the [F.A.Q.][docma-faq] section.
-License
-
-MIT. You don't have to include any copyright notice in your documentation output or templates but I'd appreciate if you let people know about this tool so we can read better documentations.
-Emoji shortcuts used in source markdown files are parsed into twemoji. Graphics and icons licensed under CC-BY 4.0.
-Related Modules
-
-
-- jsdoc-x — Parser for outputting a Javascript object from documented code via JSDoc's explain (-X) command.
-- marked — A full-featured markdown parser and compiler, written in JavaScript. Built for speed.
-- dustjs — Asynchronous Javascript templating for the browser and server.
-
+Usage
+Follow the original docs.
+License
+
\ No newline at end of file
diff --git a/docs/css/docma.css b/docs/css/docma.css
index fb483f8..e69de29 100644
--- a/docs/css/docma.css
+++ b/docs/css/docma.css
@@ -1 +0,0 @@
-img.docma{display:inline-block;border:0 none}img.docma.emoji,img.docma.emoji-sm,img.docma.emoji-1x{height:1em;width:1em;margin:0 .05em 0 .1em;vertical-align:-0.1em}img.docma.emoji-md{height:1.33em;width:1.33em;margin:0 .0665em 0 .133em;vertical-align:-0.133em}img.docma.emoji-lg{height:1.66em;width:1.66em;margin:0 .083em 0 .166em;vertical-align:-0.166em}img.docma .emoji-2x{height:2em;width:2em;margin:0 .1em 0 .2em;vertical-align:-0.2em}img.docma .emoji-3x{height:3em;width:3em;margin:0 .15em 0 .3em;vertical-align:-0.3em}img.docma .emoji-4x{height:4em;width:4em;margin:0 .2em 0 .4em;vertical-align:-0.4em}img.docma .emoji-5x{height:5em;width:5em;margin:0 .25em 0 .5em;vertical-align:-0.5em}ul.docma.task-list{list-style:none;padding-left:0;margin-left:0}ul.docma.task-list>li.docma.task-item{padding-left:0;margin-left:0}.docma-hide,.docma-ignore{position:absolute !important;display:none !important;visibility:hidden !important;opacity:0 !important;margin-right:2000px}
\ No newline at end of file
diff --git a/docs/js/docma-web.js b/docs/js/docma-web.js
index 527dfca..60deb8a 100644
--- a/docs/js/docma-web.js
+++ b/docs/js/docma-web.js
@@ -1127,7 +1127,166 @@
});
!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?module.exports=e():"function"==typeof define&&define.amd?define(e):t.page=e()}(this,function(){"use strict";function t(t){return a(r(t))}var p=Array.isArray||function(t){return"[object Array]"==Object.prototype.toString.call(t)},i=c,e=r,n=a,o=h,u=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^()])+)\\))?|\\(((?:\\\\.|[^()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function r(t){for(var e=[],n=0,i=0,o="";null!=(a=u.exec(t));){var r,a,s,h=a[0],c=a[1],p=a.index;o+=t.slice(i,p),i=p+h.length,c?o+=c[1]:(o&&(e.push(o),o=""),s=a[2],r=a[3],p=a[4],h=a[5],c=a[6],a=a[7],e.push({name:r||n++,prefix:s||"",delimiter:s=s||"/",optional:"?"===c||"*"===c,repeat:"+"===c||"*"===c,pattern:(p||h||(a?".*":"[^"+s+"]+?")).replace(/([=!:$\/()])/g,"\\$1")}))}return it.length).pop()+"/",""),s=i._getBase(),n=(a="/"===a[0]&&0!==a.indexOf(s)?s+(r?"#!":"")+a:a).indexOf("?");this.canonicalPath=t;s=new RegExp("^"+s.replace(/([.+*?=^!:${}()[\]|/\\])/g,"\\$1"));this.path=a.replace(s,"")||"/",r&&(this.path=this.path.replace("#!","")||"/"),this.title=g&&o.document.title,this.state=e||{},this.state.path=a,this.querystring=~n?i._decodeURLEncodedURIComponent(a.slice(n+1)):"",this.pathname=i._decodeURLEncodedURIComponent(~n?a.slice(0,n):a),this.params={},this.hash="",r||~this.path.indexOf("#")&&(r=this.path.split("#"),this.path=this.pathname=r[0],this.hash=i._decodeURLEncodedURIComponent(r[1])||"",this.querystring=this.querystring.split("#")[0])}function R(t,e,n){this.page=n||k;e=e||{};e.strict=e.strict||n._strict,this.path="*"===t?"(.*)":t,this.method="GET",this.regexp=i(this.path,this.keys=[],e)}b.prototype.configure=function(t){t=t||{};this._window=t.window||m&&window,this._decodeURLComponents=!1!==t.decodeURLComponents,this._popstate=!1!==t.popstate&&m,this._click=!1!==t.click&&g,this._hashbang=!!t.hashbang;t=this._window;this._popstate?t.addEventListener("popstate",this._onpopstate,!1):m&&t.removeEventListener("popstate",this._onpopstate,!1),this._click?t.document.addEventListener(y,this.clickHandler,!1):g&&t.document.removeEventListener(y,this.clickHandler,!1),this._hashbang&&m&&!w?t.addEventListener("hashchange",this._onpopstate,!1):m&&t.removeEventListener("hashchange",this._onpopstate,!1)},b.prototype.base=function(t){if(0===arguments.length)return this._base;this._base=t},b.prototype._getBase=function(){var t=this._base;if(t)return t;var e=m&&this._window&&this._window.location;return t=m&&this._hashbang&&e&&"file:"===e.protocol?e.pathname:t},b.prototype.strict=function(t){if(0===arguments.length)return this._strict;this._strict=t},b.prototype.start=function(t){var e,t=t||{};this.configure(t),!1!==t.dispatch&&(this._running=!0,_&&(e=this._window.location,e=this._hashbang&&~e.hash.indexOf("#!")?e.hash.substr(2)+e.search:this._hashbang?e.search+e.hash:e.pathname+e.search+e.hash),this.replace(e,null,!0,t.dispatch))},b.prototype.stop=function(){var t;this._running&&(this.current="",this.len=0,this._running=!1,t=this._window,this._click&&t.document.removeEventListener(y,this.clickHandler,!1),m&&t.removeEventListener("popstate",this._onpopstate,!1),m&&t.removeEventListener("hashchange",this._onpopstate,!1))},b.prototype.show=function(t,e,n,i){t=new E(t,e,this),e=this.prevContext;return this.prevContext=t,this.current=t.path,!1!==n&&this.dispatch(t,e),!1!==t.handled&&!1!==i&&t.pushState(),t},b.prototype.back=function(t,e){var n,i=this;0
404
Page Not Found
The file or page you have requested is not found.
Please make sure page address is entered correctly.
");}body_0.__dustBody=!0;return body_0}(dust));
(function(dust){dust.register("docma-api",body_0);function body_0(chk,ctx){return chk.p("navbar",ctx,ctx,{}).w("").x(ctx.getPath(false, ["template","options","sidebar","enabled"]),ctx,{"block":body_1},{}).w("");}body_0.__dustBody=!0;function body_1(chk,ctx){return chk.w("");}body_1.__dustBody=!0;function body_2(chk,ctx){return chk.p("symbol",ctx,ctx,{"symbol":ctx.getPath(true, []),"template":ctx.get(["template"], false)});}body_2.__dustBody=!0;return body_0}(dust));
@@ -1158,6 +1317,6 @@ dust.filters=dust.filters||{},dust.filters.$pt=function(e){return DocmaWeb.Utils
DocmaWeb.version = "3.3.3";
return DocmaWeb;
})();
-var docma = Object.freeze(new DocmaWeb({"version":"3.3.3","routes":[{"id":"api:","type":"api","name":"_def_","path":"api/","contentPath":null,"sourceType":"js"},{"id":"api:web","type":"api","name":"web","path":"api/web/","contentPath":null,"sourceType":"js"},{"id":"api:web/utils","type":"api","name":"web/utils","path":"api/web/utils/","contentPath":null,"sourceType":"js"},{"id":"content:changelog","type":"content","name":"changelog","path":"changelog/","contentPath":"content/changelog.html","sourceType":"md"},{"id":"content:readme","type":"content","name":"readme","path":"readme/","contentPath":"content/readme.html","sourceType":"md"},{"id":"content:license","type":"content","name":"license","path":"license/","contentPath":"content/license.html","sourceType":"md"},{"id":"content:home","type":"content","name":"home","path":"home/","contentPath":"content/home.html","sourceType":"md"},{"id":"content:templates/zebra","type":"content","name":"templates/zebra","path":"templates/zebra/","contentPath":"content/templates/zebra.html","sourceType":"md"}],"apis":{"_def_":{"documentation":[{"comment":"/**\n * Docma (builder) class for generating HTML documentation from the given\n * Javascript and/or markdown source files. This is the default object exported\n * from the `docma` Node module.\n *\n * This documentation you're reading is built with Docma.
\n * @class\n *\n * @example\n * const Docma = require('docma');\n */","meta":{"range":[1333,42348],"filename":"Docma.js","lineno":48,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100000108","name":"Docma","type":"ClassDeclaration","paramnames":[]}},"name":"Docma","longname":"Docma","kind":"class","classdesc":"Docma (builder) class for generating HTML documentation from the given\n Javascript and/or markdown source files. This is the default object exported\n from the `docma` Node module.\n\n This documentation you're reading is built with Docma.
","examples":["const Docma = require('docma');"],"scope":"global","description":"Initializes a new instance of `Docma`.","$longname":"Docma","$kind":"class","$docmaLink":"api/#Docma","$constructor":{"comment":"/**\n * Initializes a new instance of `Docma`.\n * @example\n * const docma = new Docma();\n */","meta":{"range":[1466,1482],"filename":"Docma.js","lineno":54,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100000111","name":"Docma","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"Initializes a new instance of `Docma`.","examples":["const docma = new Docma();"],"name":"Docma","longname":"Docma","kind":"class","scope":"global","params":[],"undocumented":true,"$longname":"Docma","$kind":"constructor","$docmaLink":"api/#Docma"},"$members":[{"comment":"/**\n * Docma build configuration object that defines parse options for the given\n * source files; and templating options for the Single Page Application to be\n * generated.\n *\n * This is very configurable but, you're only required to define very few\n * options such as the source files (`src`) and the destination directory\n * (`dest`) for a simple build.\n *\n * See the example at the bottom or for a real example; check out Docma's own\n * build configuration file, that generates this documentation you're reading\n * {@link https://github.com/Prozi/docma/blob/master/docma.json|here}.
\n *\n * @typedef Docma~BuildConfiguration\n * @type Object\n *\n * @param {String|Array|Object} src One or more source file/directory paths to\n * be processed. This also accepts\n * {@link https://github.com/isaacs/node-glob|Glob} strings or array of\n * globs. e.g. `./src/**/*.js` will produce an array of\n * all `.js` files under `./src` directory and sub-directories.\n *\n * JavaScript files will be parsed with JSDoc and files with `.md`, `.htm`\n * and `.html` extensions will be automatically parsed to proper formats.\n * But if you need; you can force a specific parser on defined files.\n * e.g. `./LICENSE:md` will be force-parsed to markdown.\n *\n * See examples at the bottom for a better understanding.\n * @param {Object} [assets] Non-source, static asset files/directories to be\n * copied over to build directory; so you can use/link to files such as\n * images, ZIPs, PDFs, etc... Keys of this object define the target\n * directory, relative to the build destination directory. Value of each\n * key can either be a single file path string or an array. This also\n * accepts {@link https://github.com/isaacs/node-glob|Glob} strings or\n * array of globs. e.g. `{ \"/\": [\"./*.png\"] }` will copy all PNG\n * files of the current relative directory to the root of destination\n * directory. CAUTION: Each copy operation will overwrite the\n * file if it already exists.\n * @param {String} dest Destination output directory path. CAUTION:\n * Files in this directory will be overwritten. If `clean` option is\n * enabled, all contents will be removed. Make sure you set this to\n * a correct path.\n * @param {Boolean} [clean=false] Whether the destination directory should be\n * emptied before the build.\n * @param {Boolean|Number} [debug=false] Specifies debug settings for build\n * operation and generated SPA. This takes a bitwise numeric value so\n * you can combine flags to your liking. If a `Boolean` value set,\n * `false` means `Docma.Debug.DISABLED` and `true` means\n * `Docma.Debug.ALL` which enables all debugging options. See\n * {@link #Docma.Debug|`Debug` flags enumeration} for all possible\n * values.\n * @param {Object} [jsdoc] - JSDoc parse options.\n * @param {String} [jsdoc.encoding=\"utf8\"] Encoding to be used when reading JS\n * source files.\n * @param {Boolean} [jsdoc.recurse=false] Specifies whether to recurse into\n * sub-directories when scanning for source files.\n * @param {Boolean} [jsdoc.pedantic=false] Specifies whether to treat errors as\n * fatal errors, and treat warnings as errors.\n * @param {String|Array} [jsdoc.access] Specifies which symbols to be processed\n * with the given access property. Possible values: `\"private\"`,\n * `\"protected\"`, `\"public\"` or `\"all\"` (for all access levels). By\n * default, all except private symbols are processed. Note that, if\n * access is not set for a documented symbol, it will still be included,\n * regardless of this option.\n * @param {Boolean} [jsdoc.private=false] -\n * @param {String} [jsdoc.package] The path to the `package.json` file that\n * contains the project name, version, and other details. If set to\n * `true` instead of a path string, the first `package.json` file found\n * in the source paths.\n * @param {Boolean} [jsdoc.module=true] Specifies whether to include\n * `module.exports` symbols.\n * @param {Boolean} [jsdoc.undocumented=false] Specifies whether to include\n * undocumented symbols.\n * @param {Boolean} [jsdoc.undescribed=false] Specifies whether to include\n * symbols without a description.\n * @param {Boolean} [jsdoc.ignored=false] Specifies whether to include symbols\n * marked with `ignore` tag.\n * @param {String} [jsdoc.relativePath] When set, all `symbol.meta.path` values\n * will be relative to this path.\n * @param {Function} [jsdoc.predicate] This is used to filter the parsed\n * documentation output array. If a `Function` is passed; it's invoked\n * for each included `symbol`. e.g. `function (symbol) { return symbol;\n * }` Returning a falsy value will remove the symbol from the output.\n * Returning `true` will keep the original symbol. To keep the symbol\n * and alter its contents, simply return an altered symbol object.\n * @param {Boolean} [jsdoc.hierarchy=false] Specifies whether to arrange\n * symbols by their hierarchy. This will find and move symbols that have\n * a `memberof` property to a `$members` property of their corresponding\n * owners. Also the constructor symbol will be moved to a `$constructor`\n * property of the `ClassDeclaration` symbol; if any.\n * @param {Boolean|String} [jsdoc.sort=\"alphabetic\"] Specifies whether to sort\n * the documentation symbols. For alphabetic sort, set to `true` or\n * `\"alphabetic\"`. To group-sort set to `\"grouped\"`. (Group sorting\n * is done in the following order: by memberof, by scope, by access\n * type, by kind, alphabetic.) To sort by only `\"scope\"` or\n * `\"access\"` or `\"kind\"`, set to corresponding string. (Sorting by\n * kind is done in the following order: constant, package/module,\n * namespace, class, constructor, method, property, enum, typedef,\n * event, interface, mixin, external, other members.) Set to `false`\n * to disable. Note that this sorts the documentation symbols data,\n * how it's displayed might be altered by the Docma template you're\n * using.\n * @param {Boolean} [jsdoc.allowUnknownTags=true] Specifies whether to allow\n * unrecognized tags. If set to `false` parsing will fail on unknown\n * tags.\n * @param {Array} [jsdoc.dictionaries=[\"jsdoc\", \"closure\"]] Indicates the\n * dictionaries to be used. By default, both standard JSDoc tags and\n * Closure Compiler tags are enabled.\n * @param {String} [jsdoc.includePattern=\".+\\\\.js(doc|x)?$\"] String pattern for\n * defining sources to be included. By default, only files ending in\n * `\".js\"`, \"`.jsdoc\"`, and `\".jsx\"` will be processed.\n * @param {String} [jsdoc.excludePattern=\"(^|\\\\/|\\\\\\\\)_\"] String pattern for\n * defining sources to be ignored. By default, any file starting with an\n * underscore or in a directory starting with an underscore will be\n * ignored.\n * @param {Array} [jsdoc.plugins=[]] Defines the JSDoc plugins to be used. See\n * {@link https://usejsdoc.org/about-plugins.html|this guide} on JSDoc\n * plugins.\n * @param {Object} [markdown] - Markdown parse options.\n * @param {Boolean} [markdown.gfm=true] Whether to enable\n * {@link https://help.github.com/categories/writing-on-github|GitHub flavored markdown}.\n * @param {Boolean} [markdown.tables=true] Whether to enable enable GFM\n * {@link https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables|tables}.\n * This option requires the `gfm` option to be `true`.\n * @param {Boolean} [markdown.breaks=false] Whether to enable enable GFM\n * {@link https://help.github.com/articles/basic-writing-and-formatting-syntax/#paragraphs-and-line-breaks|line breaks}.\n * This option requires the `gfm` option to be `true`.\n * @param {Boolean} [markdown.pedantic=false] Whether to conform with obscure\n * parts of `markdown.pl` as much as possible. Don't fix any of the\n * original markdown bugs or poor behavior.\n * @param {Boolean} [markdown.sanitize=false] Whether to use smarter list\n * behavior than the original markdown. May eventually be default with\n * the old behavior moved into `pedantic`.\n * @param {Boolean} [markdown.smartypants=false] Whether to use \"smart\"\n * typographic punctuation for things like quotes and dashes.\n * @param {Boolean} [markdown.xhtml=false] Self-close the tags for void\n * elements (`
`, `![]()
`, etc.) with a `\"/\"` as required by XHTML.\n * @param {Boolean} [markdown.tasks=true] Whether to parse GitHub style task\n * markdown (e.g. `- [x] task`) into checkbox elements.\n * @param {Boolean} [markdown.emoji=true] If set to `true`, emoji shortcuts\n * (e.g. `:smiley:`) are parsed into `<img />` elements\n * with {@link https://twitter.github.io/twemoji|twemoji} SVG URLs.\n * @param {Object} [app] Configuration for the generated SPA (Single Page\n * Application).\n * @param {String} [app.title=\"\"] Title of the main HTML document of the\n * generated web app. (Sets the value of the `<title>` element.)\n * @param {Array|Object} [app.meta] One or more meta elements to be set for the\n * main HTML document of the generated web app. Set arbitrary object(s)\n * for each meta element to be added. e.g. `[{ charset: \"utf-8\"}, {\n * name: \"robots\", \"content\": \"index, follow\" }]`.\n * @param {String} [app.base=\"/\"] Sets the base path of the generated web app.\n * For example if the app will operate within `/doc/*` set the base path\n * to `\"/doc\"`.\n * @param {String} [app.favicon] Local path to a `favicon.ico` file to be used\n * with the web app.\n * @param {String} [app.entrance=\"api\"] Defines the home content to be\n * displayed for the application root (when you enter the base path i.e.\n * `\"/\"`). Pass the type and name of the route in `{type}:{name}`\n * format. There are 2 types of routes: `api` for JS source\n * documentation and `content` for other HTML content such as parsed\n * markdown files. For example, if you have a grouped JS files\n * documented with a name `mylib`; to define this as the entrance of the\n * app, set this to `\"api:mylib\"`. If you have `\"README.md\"` in your\n * source files; to define this as the entrance, set this to\n * `\"content:readme\"`.\n * @param {String|Object} [app.routing] Either a `String` defining the route\n * method or an `Object` defining both the method and whether the routes\n * should be case-sensitive.\n * @param {String} [app.routing.method=\"query\"]\n * Indicates the routing method for the generated SPA (Single\n * Page Application).\n * See {@link #Docma.RoutingMethod|`RoutingMethod` enumeration}.\n * @param {Boolean} [app.routing.caseSensitive=true]\n * Indicates whether the routes should be case-sensitive.\n * Note that if this is set to `false`, same route names will\n * overwrite the previous, even if they have different case.\n * @param {String} [app.server=\"static\"] Server or host type for the SPA. This\n * information helps Docma determine how to configure the generated SPA,\n * especially if `routing.method` is set to `\"path\"`. See\n * {@link #Docma.ServerType|`ServerType` enumeration} for details.\n * @param {Object} [template] - SPA template configuration.\n * @param {String} [template.path=\"default\"] Either the path of a custom Docma\n * template or the name of a built-in template. Omit to use the default\n * built-in template.\n * @param {Object} [template.options] SPA template options. This is defined by\n * the template itself. Refer to the template's documentation for\n * options to be set at build-time. See\n * {@link templates/zebra/#template-options|Default Template options}.\n *\n * @example\n * const buildConfig = {\n * src: [\n * // using an object to define (group) names for JS files.\n * {\n * // grouping JS files under the name \"my-lib\".\n * // This name also defines the api route name: e.g. ?api=my-lib or api/my-lib/\n * 'my-lib': [\n * './src/** /*.js', // recurse all JS files under /src\n * './lib/some-other.js',\n * '!./lib/ignored.js' // notice the bang! prefix to exclude this file\n * ],\n * // naming another api route\n * 'other-lib': './other/*.js', // ?api=other-lib\n * },\n *\n * // ungrouped js files will be merged under default route\n * './src/main.js', // ?api or ?api=_def_\n * './src/main.utils.js', // merged into same ?api or ?api=_def_\n *\n * // including markdown (\"content\") files\n * './CHANGELOG.md', // this will have 'changelog' as route name.\n * // i.e. ?content=changelog\n * // forcing specific parser on files:\n * './LICENSE:md', // LICENSE file with no-extension is forced\n * // to markdown via :md suffix.\n * // route will be ?content=license or license/\n * // using an object to rename the route for the given markdown files\n * {\n * guide: './README.md' // this will have 'guide' as content route name\n * } // i.e. ?content=guide or guide/\n * ],\n * dest: './output/docs', // output directory for the generated docs\n * app: {\n * title: 'My Documentation', // title of the app\n * routing: 'query', // routing method \"query\" or \"path\"\n * entrance: 'content:guide', // initial route to load on entrance\n * base: '/' // base path of the SPA\n * },\n *\n * // template-specific configuration.\n * // for Zebra template, see https://onury.io/docma/templates/zebra\n * template: {\n * path: 'zebra',\n * options: {\n * title: {\n * label: 'My Docs',\n * href: '/docs/?'\n * },\n * navbar: true,\n * sidebar: {\n * enabled: true,\n * outline: 'tree'\n * }\n * }\n * }\n * };\n * // See Docma's own configuration @\n * // https://github.com/Prozi/docma/blob/master/docma.json\n */","meta":{"filename":"Docma.js","lineno":1235,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Docma build configuration object that defines parse options for the given\n source files; and templating options for the Single Page Application to be\n generated.\n\n This is very configurable but, you're only required to define very few\n options such as the source files (`src`) and the destination directory\n (`dest`) for a simple build.\n\n See the example at the bottom or for a real example; check out Docma's own\n build configuration file, that generates this documentation you're reading\n {@link https://github.com/Prozi/docma/blob/master/docma.json|here}.
","kind":"typedef","name":"BuildConfiguration","type":{"names":["Object"]},"params":[{"type":{"names":["String","Array","Object"]},"description":"One or more source file/directory paths to\n be processed. This also accepts\n {@link https://github.com/isaacs/node-glob|Glob} strings or array of\n globs. e.g. `./src/**/*.js` will produce an array of\n all `.js` files under `./src` directory and sub-directories.\n\n JavaScript files will be parsed with JSDoc and files with `.md`, `.htm`\n and `.html` extensions will be automatically parsed to proper formats.\n But if you need; you can force a specific parser on defined files.\n e.g. `./LICENSE:md` will be force-parsed to markdown.\n\n See examples at the bottom for a better understanding.","name":"src"},{"type":{"names":["Object"]},"optional":true,"description":"Non-source, static asset files/directories to be\n copied over to build directory; so you can use/link to files such as\n images, ZIPs, PDFs, etc... Keys of this object define the target\n directory, relative to the build destination directory. Value of each\n key can either be a single file path string or an array. This also\n accepts {@link https://github.com/isaacs/node-glob|Glob} strings or\n array of globs. e.g. `{ \"/\": [\"./*.png\"] }` will copy all PNG\n files of the current relative directory to the root of destination\n directory. CAUTION: Each copy operation will overwrite the\n file if it already exists.","name":"assets"},{"type":{"names":["String"]},"description":"Destination output directory path. CAUTION:\n Files in this directory will be overwritten. If `clean` option is\n enabled, all contents will be removed. Make sure you set this to\n a correct path.","name":"dest"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the destination directory should be\n emptied before the build.","name":"clean"},{"type":{"names":["Boolean","Number"]},"optional":true,"defaultvalue":false,"description":"Specifies debug settings for build\n operation and generated SPA. This takes a bitwise numeric value so\n you can combine flags to your liking. If a `Boolean` value set,\n `false` means `Docma.Debug.DISABLED` and `true` means\n `Docma.Debug.ALL` which enables all debugging options. See\n {@link #Docma.Debug|`Debug` flags enumeration} for all possible\n values.","name":"debug"},{"type":{"names":["Object"]},"optional":true,"description":"JSDoc parse options.","name":"jsdoc"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"utf8\"","description":"Encoding to be used when reading JS\n source files.","name":"jsdoc.encoding"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to recurse into\n sub-directories when scanning for source files.","name":"jsdoc.recurse"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to treat errors as\n fatal errors, and treat warnings as errors.","name":"jsdoc.pedantic"},{"type":{"names":["String","Array"]},"optional":true,"description":"Specifies which symbols to be processed\n with the given access property. Possible values: `\"private\"`,\n `\"protected\"`, `\"public\"` or `\"all\"` (for all access levels). By\n default, all except private symbols are processed. Note that, if\n access is not set for a documented symbol, it will still be included,\n regardless of this option.","name":"jsdoc.access"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"-","name":"jsdoc.private"},{"type":{"names":["String"]},"optional":true,"description":"The path to the `package.json` file that\n contains the project name, version, and other details. If set to\n `true` instead of a path string, the first `package.json` file found\n in the source paths.","name":"jsdoc.package"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Specifies whether to include\n `module.exports` symbols.","name":"jsdoc.module"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to include\n undocumented symbols.","name":"jsdoc.undocumented"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to include\n symbols without a description.","name":"jsdoc.undescribed"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to include symbols\n marked with `ignore` tag.","name":"jsdoc.ignored"},{"type":{"names":["String"]},"optional":true,"description":"When set, all `symbol.meta.path` values\n will be relative to this path.","name":"jsdoc.relativePath"},{"type":{"names":["function"]},"optional":true,"description":"This is used to filter the parsed\n documentation output array. If a `Function` is passed; it's invoked\n for each included `symbol`. e.g. `function (symbol) { return symbol;\n }` Returning a falsy value will remove the symbol from the output.\n Returning `true` will keep the original symbol. To keep the symbol\n and alter its contents, simply return an altered symbol object.","name":"jsdoc.predicate"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to arrange\n symbols by their hierarchy. This will find and move symbols that have\n a `memberof` property to a `$members` property of their corresponding\n owners. Also the constructor symbol will be moved to a `$constructor`\n property of the `ClassDeclaration` symbol; if any.","name":"jsdoc.hierarchy"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":"\"alphabetic\"","description":"Specifies whether to sort\n the documentation symbols. For alphabetic sort, set to `true` or\n `\"alphabetic\"`. To group-sort set to `\"grouped\"`. (Group sorting\n is done in the following order: by memberof, by scope, by access\n type, by kind, alphabetic.) To sort by only `\"scope\"` or\n `\"access\"` or `\"kind\"`, set to corresponding string. (Sorting by\n kind is done in the following order: constant, package/module,\n namespace, class, constructor, method, property, enum, typedef,\n event, interface, mixin, external, other members.) Set to `false`\n to disable. Note that this sorts the documentation symbols data,\n how it's displayed might be altered by the Docma template you're\n using.","name":"jsdoc.sort"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Specifies whether to allow\n unrecognized tags. If set to `false` parsing will fail on unknown\n tags.","name":"jsdoc.allowUnknownTags"},{"type":{"names":["Array"]},"optional":true,"defaultvalue":"[\"jsdoc\", \"closure\"]","description":"Indicates the\n dictionaries to be used. By default, both standard JSDoc tags and\n Closure Compiler tags are enabled.","name":"jsdoc.dictionaries"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\".+\\\\.js(doc|x)?$\"","description":"String pattern for\n defining sources to be included. By default, only files ending in\n `\".js\"`, \"`.jsdoc\"`, and `\".jsx\"` will be processed.","name":"jsdoc.includePattern"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"(^|\\\\/|\\\\\\\\)_\"","description":"String pattern for\n defining sources to be ignored. By default, any file starting with an\n underscore or in a directory starting with an underscore will be\n ignored.","name":"jsdoc.excludePattern"},{"type":{"names":["Array"]},"optional":true,"defaultvalue":"[]","description":"Defines the JSDoc plugins to be used. See\n {@link https://usejsdoc.org/about-plugins.html|this guide} on JSDoc\n plugins.","name":"jsdoc.plugins"},{"type":{"names":["Object"]},"optional":true,"description":"Markdown parse options.","name":"markdown"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to enable\n {@link https://help.github.com/categories/writing-on-github|GitHub flavored markdown}.","name":"markdown.gfm"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to enable enable GFM\n {@link https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables|tables}.\n This option requires the `gfm` option to be `true`.","name":"markdown.tables"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to enable enable GFM\n {@link https://help.github.com/articles/basic-writing-and-formatting-syntax/#paragraphs-and-line-breaks|line breaks}.\n This option requires the `gfm` option to be `true`.","name":"markdown.breaks"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to conform with obscure\n parts of `markdown.pl` as much as possible. Don't fix any of the\n original markdown bugs or poor behavior.","name":"markdown.pedantic"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to use smarter list\n behavior than the original markdown. May eventually be default with\n the old behavior moved into `pedantic`.","name":"markdown.sanitize"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to use \"smart\"\n typographic punctuation for things like quotes and dashes.","name":"markdown.smartypants"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Self-close the tags for void\n elements (`
`, `![]()
`, etc.) with a `\"/\"` as required by XHTML.","name":"markdown.xhtml"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to parse GitHub style task\n markdown (e.g. `- [x] task`) into checkbox elements.","name":"markdown.tasks"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"If set to `true`, emoji shortcuts\n (e.g. `:smiley:`) are parsed into `<img />` elements\n with {@link https://twitter.github.io/twemoji|twemoji} SVG URLs.","name":"markdown.emoji"},{"type":{"names":["Object"]},"optional":true,"description":"Configuration for the generated SPA (Single Page\n Application).","name":"app"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"\"","description":"Title of the main HTML document of the\n generated web app. (Sets the value of the `<title>` element.)","name":"app.title"},{"type":{"names":["Array","Object"]},"optional":true,"description":"One or more meta elements to be set for the\n main HTML document of the generated web app. Set arbitrary object(s)\n for each meta element to be added. e.g. `[{ charset: \"utf-8\"}, {\n name: \"robots\", \"content\": \"index, follow\" }]`.","name":"app.meta"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"/\"","description":"Sets the base path of the generated web app.\n For example if the app will operate within `/doc/*` set the base path\n to `\"/doc\"`.","name":"app.base"},{"type":{"names":["String"]},"optional":true,"description":"Local path to a `favicon.ico` file to be used\n with the web app.","name":"app.favicon"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"api\"","description":"Defines the home content to be\n displayed for the application root (when you enter the base path i.e.\n `\"/\"`). Pass the type and name of the route in `{type}:{name}`\n format. There are 2 types of routes: `api` for JS source\n documentation and `content` for other HTML content such as parsed\n markdown files. For example, if you have a grouped JS files\n documented with a name `mylib`; to define this as the entrance of the\n app, set this to `\"api:mylib\"`. If you have `\"README.md\"` in your\n source files; to define this as the entrance, set this to\n `\"content:readme\"`.","name":"app.entrance"},{"type":{"names":["String","Object"]},"optional":true,"description":"Either a `String` defining the route\n method or an `Object` defining both the method and whether the routes\n should be case-sensitive.","name":"app.routing"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"query\"","description":"Indicates the routing method for the generated SPA (Single\n Page Application).\n See {@link #Docma.RoutingMethod|`RoutingMethod` enumeration}.","name":"app.routing.method"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Indicates whether the routes should be case-sensitive.\n Note that if this is set to `false`, same route names will\n overwrite the previous, even if they have different case.","name":"app.routing.caseSensitive"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"static\"","description":"Server or host type for the SPA. This\n information helps Docma determine how to configure the generated SPA,\n especially if `routing.method` is set to `\"path\"`. See\n {@link #Docma.ServerType|`ServerType` enumeration} for details.","name":"app.server"},{"type":{"names":["Object"]},"optional":true,"description":"SPA template configuration.","name":"template"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"default\"","description":"Either the path of a custom Docma\n template or the name of a built-in template. Omit to use the default\n built-in template.","name":"template.path"},{"type":{"names":["Object"]},"optional":true,"description":"SPA template options. This is defined by\n the template itself. Refer to the template's documentation for\n options to be set at build-time. See\n {@link templates/zebra/#template-options|Default Template options}.","name":"template.options"}],"examples":["const buildConfig = {\n src: [\n // using an object to define (group) names for JS files.\n {\n // grouping JS files under the name \"my-lib\".\n // This name also defines the api route name: e.g. ?api=my-lib or api/my-lib/\n 'my-lib': [\n './src/** /*.js', // recurse all JS files under /src\n './lib/some-other.js',\n '!./lib/ignored.js' // notice the bang! prefix to exclude this file\n ],\n // naming another api route\n 'other-lib': './other/*.js', // ?api=other-lib\n },\n\n // ungrouped js files will be merged under default route\n './src/main.js', // ?api or ?api=_def_\n './src/main.utils.js', // merged into same ?api or ?api=_def_\n\n // including markdown (\"content\") files\n './CHANGELOG.md', // this will have 'changelog' as route name.\n // i.e. ?content=changelog\n // forcing specific parser on files:\n './LICENSE:md', // LICENSE file with no-extension is forced\n // to markdown via :md suffix.\n // route will be ?content=license or license/\n // using an object to rename the route for the given markdown files\n {\n guide: './README.md' // this will have 'guide' as content route name\n } // i.e. ?content=guide or guide/\n ],\n dest: './output/docs', // output directory for the generated docs\n app: {\n title: 'My Documentation', // title of the app\n routing: 'query', // routing method \"query\" or \"path\"\n entrance: 'content:guide', // initial route to load on entrance\n base: '/' // base path of the SPA\n },\n\n // template-specific configuration.\n // for Zebra template, see https://onury.io/docma/templates/zebra\n template: {\n path: 'zebra',\n options: {\n title: {\n label: 'My Docs',\n href: '/docs/?'\n },\n navbar: true,\n sidebar: {\n enabled: true,\n outline: 'tree'\n }\n }\n }\n };\n // See Docma's own configuration @\n // https://github.com/Prozi/docma/blob/master/docma.json"],"memberof":"Docma","longname":"Docma~BuildConfiguration","scope":"inner","$longname":"Docma~BuildConfiguration","$kind":"typedef","$docmaLink":"api/#Docma~BuildConfiguration"}]},{"comment":"/**\n * Parses the given source files and builds a Single Page Application (SPA)\n * with the given Docma template.\n *\n * For a verbose build, `debug` option should be {@link #Docma.Debug|enabled}.\n *\n * @param {Object|String} config\n * Either a build configuration object or the file path of a\n * configuration JSON file.\n * See {@link #Docma~BuildConfiguration|`BuildConfiguration`} for details.\n *\n * @returns {Promise}\n * Promise that resolves to a `Boolean` value for whether the build\n * operation is successful. This will always return `true` if\n * no errors occur. You should `.catch()` the errors of the\n * promise chain.\n *\n * @example\n * const docma = new Docma();\n * docma.build(config)\n * \t.then(success => {\n * \t\tconsole.log('Documentation is built successfully.');\n * \t})\n * \t.catch(error => {\n * \t\tconsole.log(error.stack);\n * \t});\n */","meta":{"range":[34541,42032],"filename":"Docma.js","lineno":893,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100002720","name":"Docma#build","type":"MethodDefinition","paramnames":["config"]},"vars":{"":null}},"description":"Parses the given source files and builds a Single Page Application (SPA)\n with the given Docma template.\n\n For a verbose build, `debug` option should be {@link #Docma.Debug|enabled}.","params":[{"type":{"names":["Object","String"]},"description":"Either a build configuration object or the file path of a\n configuration JSON file.\n See {@link #Docma~BuildConfiguration|`BuildConfiguration`} for details.","name":"config"}],"returns":[{"type":{"names":["Promise."]},"description":"Promise that resolves to a `Boolean` value for whether the build\n operation is successful. This will always return `true` if\n no errors occur. You should `.catch()` the errors of the\n promise chain."}],"examples":["const docma = new Docma();\n docma.build(config)\n \t.then(success => {\n \t\tconsole.log('Documentation is built successfully.');\n \t})\n \t.catch(error => {\n \t\tconsole.log(error.stack);\n \t});"],"name":"build","longname":"Docma#build","kind":"function","memberof":"Docma","scope":"instance","$longname":"Docma#build","$kind":"method","$docmaLink":"api/#Docma#build"},{"comment":"/**\n * Creates a new instance of `Docma`.\n * This is equivalent to `new Docma()`.\n *\n * @returns {Docma} - Docma instance.\n */","meta":{"range":[42295,42346],"filename":"Docma.js","lineno":1063,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003405","name":"Docma.create","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"Creates a new instance of `Docma`.\n This is equivalent to `new Docma()`.","returns":[{"type":{"names":["Docma"]},"description":"- Docma instance."}],"name":"create","longname":"Docma.create","kind":"function","memberof":"Docma","scope":"static","params":[],"$longname":"Docma.create","$kind":"method","$docmaLink":"api/#Docma.create"},{"comment":"/**\n * Enumerates bitwise debug flags.\n * @enum {Number}\n */","meta":{"range":[45870,46918],"filename":"Docma.js","lineno":1177,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003447","name":"Docma.Debug","type":"ObjectExpression","value":"{\"DISABLED\":0,\"BUILD_LOGS\":1,\"WEB_LOGS\":2,\"VERBOSE\":4,\"NO_MINIFY\":8,\"JSDOC_OUTPUT\":16,\"ALL\":31}","paramnames":[]}},"description":"Enumerates bitwise debug flags.","kind":"member","isEnum":true,"type":{"names":["Number"]},"name":"Debug","longname":"Docma.Debug","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Enables all debug flags.\n * @type {Number}\n */","meta":{"range":[46908,46915],"filename":"Docma.js","lineno":1217,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003464","name":"ALL","type":"Literal","value":31}},"description":"Enables all debug flags.","type":{"names":["Number"]},"name":"ALL","longname":"Docma.Debug.ALL","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":31},{"comment":"/**\n * Outputs build logs to the Node console.\n * @type {Number}\n */","meta":{"range":[46061,46074],"filename":"Docma.js","lineno":1187,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003454","name":"BUILD_LOGS","type":"Literal","value":1}},"description":"Outputs build logs to the Node console.","type":{"names":["Number"]},"name":"BUILD_LOGS","longname":"Docma.Debug.BUILD_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":1},{"comment":"/**\n * Disables debugging.\n * @type {Number}\n */","meta":{"range":[45957,45968],"filename":"Docma.js","lineno":1182,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003452","name":"DISABLED","type":"Literal","value":0}},"description":"Disables debugging.","type":{"names":["Number"]},"name":"DISABLED","longname":"Docma.Debug.DISABLED","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":0},{"comment":"/**\n * Outputs one or more `[name.]jsdoc.json` files that include\n * documentation data for each (grouped) javascript source.\n * `name` is the group name you give when you define the source\n * files. This is useful for investigating the raw JSDoc output.\n * @type {Number}\n */","meta":{"range":[46814,46830],"filename":"Docma.js","lineno":1212,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003462","name":"JSDOC_OUTPUT","type":"Literal","value":16}},"description":"Outputs one or more `[name.]jsdoc.json` files that include\n documentation data for each (grouped) javascript source.\n `name` is the group name you give when you define the source\n files. This is useful for investigating the raw JSDoc output.","type":{"names":["Number"]},"name":"JSDOC_OUTPUT","longname":"Docma.Debug.JSDOC_OUTPUT","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":16},{"comment":"/**\n * Disables minification for the generated web app assets such as\n * Javascript files. This is useful if you're debugging a custom\n * Docma template.\n * @type {Number}\n */","meta":{"range":[46486,46498],"filename":"Docma.js","lineno":1204,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003460","name":"NO_MINIFY","type":"Literal","value":8}},"description":"Disables minification for the generated web app assets such as\n Javascript files. This is useful if you're debugging a custom\n Docma template.","type":{"names":["Number"]},"name":"NO_MINIFY","longname":"Docma.Debug.NO_MINIFY","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":8},{"comment":"/**\n * Outputs verbose logs to consoles.\n * @type {Number}\n */","meta":{"range":[46266,46276],"filename":"Docma.js","lineno":1197,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003458","name":"VERBOSE","type":"Literal","value":4}},"description":"Outputs verbose logs to consoles.","type":{"names":["Number"]},"name":"VERBOSE","longname":"Docma.Debug.VERBOSE","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":4},{"comment":"/**\n * Outputs app logs to the browser console.\n * @type {Number}\n */","meta":{"range":[46168,46179],"filename":"Docma.js","lineno":1192,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003456","name":"WEB_LOGS","type":"Literal","value":2}},"description":"Outputs app logs to the browser console.","type":{"names":["Number"]},"name":"WEB_LOGS","longname":"Docma.Debug.WEB_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":2}],"$longname":"Docma.Debug","$kind":"enum","$docmaLink":"api/#Docma.Debug","$members":[{"comment":"/**\n * Enables all debug flags.\n * @type {Number}\n */","meta":{"range":[46908,46915],"filename":"Docma.js","lineno":1217,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003464","name":"ALL","type":"Literal","value":31}},"description":"Enables all debug flags.","type":{"names":["Number"]},"name":"ALL","longname":"Docma.Debug.ALL","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":31,"$longname":"Docma.Debug.ALL","$kind":"property","$docmaLink":"api/#Docma.Debug.ALL"},{"comment":"/**\n * Outputs build logs to the Node console.\n * @type {Number}\n */","meta":{"range":[46061,46074],"filename":"Docma.js","lineno":1187,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003454","name":"BUILD_LOGS","type":"Literal","value":1}},"description":"Outputs build logs to the Node console.","type":{"names":["Number"]},"name":"BUILD_LOGS","longname":"Docma.Debug.BUILD_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":1,"$longname":"Docma.Debug.BUILD_LOGS","$kind":"property","$docmaLink":"api/#Docma.Debug.BUILD_LOGS"},{"comment":"/**\n * Disables debugging.\n * @type {Number}\n */","meta":{"range":[45957,45968],"filename":"Docma.js","lineno":1182,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003452","name":"DISABLED","type":"Literal","value":0}},"description":"Disables debugging.","type":{"names":["Number"]},"name":"DISABLED","longname":"Docma.Debug.DISABLED","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":0,"$longname":"Docma.Debug.DISABLED","$kind":"property","$docmaLink":"api/#Docma.Debug.DISABLED"},{"comment":"/**\n * Outputs one or more `[name.]jsdoc.json` files that include\n * documentation data for each (grouped) javascript source.\n * `name` is the group name you give when you define the source\n * files. This is useful for investigating the raw JSDoc output.\n * @type {Number}\n */","meta":{"range":[46814,46830],"filename":"Docma.js","lineno":1212,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003462","name":"JSDOC_OUTPUT","type":"Literal","value":16}},"description":"Outputs one or more `[name.]jsdoc.json` files that include\n documentation data for each (grouped) javascript source.\n `name` is the group name you give when you define the source\n files. This is useful for investigating the raw JSDoc output.","type":{"names":["Number"]},"name":"JSDOC_OUTPUT","longname":"Docma.Debug.JSDOC_OUTPUT","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":16,"$longname":"Docma.Debug.JSDOC_OUTPUT","$kind":"property","$docmaLink":"api/#Docma.Debug.JSDOC_OUTPUT"},{"comment":"/**\n * Disables minification for the generated web app assets such as\n * Javascript files. This is useful if you're debugging a custom\n * Docma template.\n * @type {Number}\n */","meta":{"range":[46486,46498],"filename":"Docma.js","lineno":1204,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003460","name":"NO_MINIFY","type":"Literal","value":8}},"description":"Disables minification for the generated web app assets such as\n Javascript files. This is useful if you're debugging a custom\n Docma template.","type":{"names":["Number"]},"name":"NO_MINIFY","longname":"Docma.Debug.NO_MINIFY","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":8,"$longname":"Docma.Debug.NO_MINIFY","$kind":"property","$docmaLink":"api/#Docma.Debug.NO_MINIFY"},{"comment":"/**\n * Outputs verbose logs to consoles.\n * @type {Number}\n */","meta":{"range":[46266,46276],"filename":"Docma.js","lineno":1197,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003458","name":"VERBOSE","type":"Literal","value":4}},"description":"Outputs verbose logs to consoles.","type":{"names":["Number"]},"name":"VERBOSE","longname":"Docma.Debug.VERBOSE","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":4,"$longname":"Docma.Debug.VERBOSE","$kind":"property","$docmaLink":"api/#Docma.Debug.VERBOSE"},{"comment":"/**\n * Outputs app logs to the browser console.\n * @type {Number}\n */","meta":{"range":[46168,46179],"filename":"Docma.js","lineno":1192,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003456","name":"WEB_LOGS","type":"Literal","value":2}},"description":"Outputs app logs to the browser console.","type":{"names":["Number"]},"name":"WEB_LOGS","longname":"Docma.Debug.WEB_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":2,"$longname":"Docma.Debug.WEB_LOGS","$kind":"property","$docmaLink":"api/#Docma.Debug.WEB_LOGS"}]},{"comment":"/**\n * Enumerates Docma SPA route types.\n * @enum {String}\n * @readonly\n *\n * @example Routing Method: \"query\" \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ ?api\n * api web ?api=web\n * content templates ?content=templates\n * content guide ?content=guide\n *\n * @example Routing Method: \"path\" \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ api/\n * api web api/web/\n * content templates templates/\n * content guide guide/\n */","meta":{"range":[44302,44653],"filename":"Docma.js","lineno":1121,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003423","name":"Docma.RouteType","type":"ObjectExpression","value":"{\"API\":\"api\",\"CONTENT\":\"content\"}","paramnames":[]}},"description":"Enumerates Docma SPA route types.","kind":"member","isEnum":true,"type":{"names":["String"]},"readonly":true,"examples":["Routing Method: \"query\" \n type name path\n ------- ---------------- --------------------------\n api _def_ ?api\n api web ?api=web\n content templates ?content=templates\n content guide ?content=guide\n\n ","Routing Method: \"path\" \n type name path\n ------- ---------------- --------------------------\n api _def_ api/\n api web api/web/\n content templates templates/\n content guide guide/"],"name":"RouteType","longname":"Docma.RouteType","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Indicates a route for API documentation content, generated from\n * Javascript source files via JSDoc.\n * @type {String}\n */","meta":{"range":[44480,44490],"filename":"Docma.js","lineno":1127,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003428","name":"API","type":"Literal","value":"api"}},"description":"Indicates a route for API documentation content, generated from\n Javascript source files via JSDoc.","type":{"names":["String"]},"name":"API","longname":"Docma.RouteType.API","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"api"},{"comment":"/**\n * Indicates a route for other content, such as HTML files generated\n * from markdown.\n * @type {String}\n */","meta":{"range":[44632,44650],"filename":"Docma.js","lineno":1133,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003430","name":"CONTENT","type":"Literal","value":"content"}},"description":"Indicates a route for other content, such as HTML files generated\n from markdown.","type":{"names":["String"]},"name":"CONTENT","longname":"Docma.RouteType.CONTENT","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"content"}],"$longname":"Docma.RouteType","$kind":"enum","$docmaLink":"api/#Docma.RouteType","$members":[{"comment":"/**\n * Indicates a route for API documentation content, generated from\n * Javascript source files via JSDoc.\n * @type {String}\n */","meta":{"range":[44480,44490],"filename":"Docma.js","lineno":1127,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003428","name":"API","type":"Literal","value":"api"}},"description":"Indicates a route for API documentation content, generated from\n Javascript source files via JSDoc.","type":{"names":["String"]},"name":"API","longname":"Docma.RouteType.API","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"api","$longname":"Docma.RouteType.API","$kind":"property","$docmaLink":"api/#Docma.RouteType.API"},{"comment":"/**\n * Indicates a route for other content, such as HTML files generated\n * from markdown.\n * @type {String}\n */","meta":{"range":[44632,44650],"filename":"Docma.js","lineno":1133,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003430","name":"CONTENT","type":"Literal","value":"content"}},"description":"Indicates a route for other content, such as HTML files generated\n from markdown.","type":{"names":["String"]},"name":"CONTENT","longname":"Docma.RouteType.CONTENT","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"content","$longname":"Docma.RouteType.CONTENT","$kind":"property","$docmaLink":"api/#Docma.RouteType.CONTENT"}]},{"comment":"/**\n * Enumerates the routing methods for a Docma generated web application.\n * @enum {String}\n * @readonly\n */","meta":{"range":[42556,43561],"filename":"Docma.js","lineno":1077,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003413","name":"Docma.RoutingMethod","type":"ObjectExpression","value":"{\"QUERY\":\"query\",\"PATH\":\"path\"}","paramnames":[]}},"description":"Enumerates the routing methods for a Docma generated web application.","kind":"member","isEnum":true,"type":{"names":["String"]},"readonly":true,"name":"RoutingMethod","longname":"Docma.RoutingMethod","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Indicates that the SPA routes are based on path params rather than\n * query-strings. For example, for a named group of JS source files\n * (e.g. `\"mylib\"`), the generated documentation will be accessible at\n * `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `readme/`.\n * @type {String}\n */","meta":{"range":[43546,43558],"filename":"Docma.js","lineno":1097,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003420","name":"PATH","type":"Literal","value":"path"}},"description":"Indicates that the SPA routes are based on path params rather than\n query-strings. For example, for a named group of JS source files\n (e.g. `\"mylib\"`), the generated documentation will be accessible at\n `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `readme/`.","type":{"names":["String"]},"name":"PATH","longname":"Docma.RoutingMethod.PATH","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"path"},{"comment":"/**\n * Indicates that the SPA routes are based on query-strings.\n * For example, for a named group of JS source files (e.g. `\"mylib\"`),\n * the generated documentation will be accessible at `?api=mylib`.\n * Ungrouped JS documentation will be accessible at `?api`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `?content=readme`.\n * @type {String}\n */","meta":{"range":[43047,43061],"filename":"Docma.js","lineno":1087,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003418","name":"QUERY","type":"Literal","value":"query"}},"description":"Indicates that the SPA routes are based on query-strings.\n For example, for a named group of JS source files (e.g. `\"mylib\"`),\n the generated documentation will be accessible at `?api=mylib`.\n Ungrouped JS documentation will be accessible at `?api`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `?content=readme`.","type":{"names":["String"]},"name":"QUERY","longname":"Docma.RoutingMethod.QUERY","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"query"}],"$longname":"Docma.RoutingMethod","$kind":"enum","$docmaLink":"api/#Docma.RoutingMethod","$members":[{"comment":"/**\n * Indicates that the SPA routes are based on path params rather than\n * query-strings. For example, for a named group of JS source files\n * (e.g. `\"mylib\"`), the generated documentation will be accessible at\n * `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `readme/`.\n * @type {String}\n */","meta":{"range":[43546,43558],"filename":"Docma.js","lineno":1097,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003420","name":"PATH","type":"Literal","value":"path"}},"description":"Indicates that the SPA routes are based on path params rather than\n query-strings. For example, for a named group of JS source files\n (e.g. `\"mylib\"`), the generated documentation will be accessible at\n `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `readme/`.","type":{"names":["String"]},"name":"PATH","longname":"Docma.RoutingMethod.PATH","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"path","$longname":"Docma.RoutingMethod.PATH","$kind":"property","$docmaLink":"api/#Docma.RoutingMethod.PATH"},{"comment":"/**\n * Indicates that the SPA routes are based on query-strings.\n * For example, for a named group of JS source files (e.g. `\"mylib\"`),\n * the generated documentation will be accessible at `?api=mylib`.\n * Ungrouped JS documentation will be accessible at `?api`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `?content=readme`.\n * @type {String}\n */","meta":{"range":[43047,43061],"filename":"Docma.js","lineno":1087,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003418","name":"QUERY","type":"Literal","value":"query"}},"description":"Indicates that the SPA routes are based on query-strings.\n For example, for a named group of JS source files (e.g. `\"mylib\"`),\n the generated documentation will be accessible at `?api=mylib`.\n Ungrouped JS documentation will be accessible at `?api`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `?content=readme`.","type":{"names":["String"]},"name":"QUERY","longname":"Docma.RoutingMethod.QUERY","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"query","$longname":"Docma.RoutingMethod.QUERY","$kind":"property","$docmaLink":"api/#Docma.RoutingMethod.QUERY"}]},{"comment":"/**\n * Enumerates the server/host types for Docma generated SPA.\n * The generated SPA is not limited to these hosts but Docma will generate\n * additional server config files for these hosts; especially if the\n * routing method is set to `\"path\"`. For example, for Apache;\n * an `.htaccess` file will be auto-generated with redirect rules for\n * (sub) routes. For GitHub, sub-directories will be generated\n * (just like Jekyll) with index files for redirecting via http-meta\n * refresh.\n * @enum {String}\n * @readonly\n */","meta":{"range":[45187,45804],"filename":"Docma.js","lineno":1148,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003433","name":"Docma.ServerType","type":"ObjectExpression","value":"{\"APACHE\":\"apache\",\"GITHUB\":\"github\",\"STATIC\":\"static\",\"WINDOWS\":\"windows\"}","paramnames":[]}},"description":"Enumerates the server/host types for Docma generated SPA.\n The generated SPA is not limited to these hosts but Docma will generate\n additional server config files for these hosts; especially if the\n routing method is set to `\"path\"`. For example, for Apache;\n an `.htaccess` file will be auto-generated with redirect rules for\n (sub) routes. For GitHub, sub-directories will be generated\n (just like Jekyll) with index files for redirecting via http-meta\n refresh.","kind":"member","isEnum":true,"type":{"names":["String"]},"readonly":true,"name":"ServerType","longname":"Docma.ServerType","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Indicates that an Apache server will be hosting the generated SPA.\n * @type {String}\n */","meta":{"range":[45326,45342],"filename":"Docma.js","lineno":1153,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003438","name":"APACHE","type":"Literal","value":"apache"}},"description":"Indicates that an Apache server will be hosting the generated SPA.","type":{"names":["String"]},"name":"APACHE","longname":"Docma.ServerType.APACHE","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"apache"},{"comment":"/**\n * Indicates that SPA will be hosted via\n * {@link https://pages.github.com|GitHub Pages}.\n * @type {String}\n */","meta":{"range":[45488,45504],"filename":"Docma.js","lineno":1159,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003440","name":"GITHUB","type":"Literal","value":"github"}},"description":"Indicates that SPA will be hosted via\n {@link https://pages.github.com|GitHub Pages}.","type":{"names":["String"]},"name":"GITHUB","longname":"Docma.ServerType.GITHUB","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"github"},{"comment":"/**\n * Indicates that SPA will be hosted as static HTML files.\n * Similar to `Docma.ServerType.GITHUB`.\n * @type {String}\n */","meta":{"range":[45659,45675],"filename":"Docma.js","lineno":1165,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003442","name":"STATIC","type":"Literal","value":"static"}},"description":"Indicates that SPA will be hosted as static HTML files.\n Similar to `Docma.ServerType.GITHUB`.","type":{"names":["String"]},"name":"STATIC","longname":"Docma.ServerType.STATIC","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"static"},{"comment":"/**\n * Indicates that SPA will be hosted on a Windows server.\n * @type {String}\n */","meta":{"range":[45783,45801],"filename":"Docma.js","lineno":1170,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003444","name":"WINDOWS","type":"Literal","value":"windows"}},"description":"Indicates that SPA will be hosted on a Windows server.","type":{"names":["String"]},"name":"WINDOWS","longname":"Docma.ServerType.WINDOWS","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"windows"}],"$longname":"Docma.ServerType","$kind":"enum","$docmaLink":"api/#Docma.ServerType","$members":[{"comment":"/**\n * Indicates that an Apache server will be hosting the generated SPA.\n * @type {String}\n */","meta":{"range":[45326,45342],"filename":"Docma.js","lineno":1153,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003438","name":"APACHE","type":"Literal","value":"apache"}},"description":"Indicates that an Apache server will be hosting the generated SPA.","type":{"names":["String"]},"name":"APACHE","longname":"Docma.ServerType.APACHE","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"apache","$longname":"Docma.ServerType.APACHE","$kind":"property","$docmaLink":"api/#Docma.ServerType.APACHE"},{"comment":"/**\n * Indicates that SPA will be hosted via\n * {@link https://pages.github.com|GitHub Pages}.\n * @type {String}\n */","meta":{"range":[45488,45504],"filename":"Docma.js","lineno":1159,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003440","name":"GITHUB","type":"Literal","value":"github"}},"description":"Indicates that SPA will be hosted via\n {@link https://pages.github.com|GitHub Pages}.","type":{"names":["String"]},"name":"GITHUB","longname":"Docma.ServerType.GITHUB","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"github","$longname":"Docma.ServerType.GITHUB","$kind":"property","$docmaLink":"api/#Docma.ServerType.GITHUB"},{"comment":"/**\n * Indicates that SPA will be hosted as static HTML files.\n * Similar to `Docma.ServerType.GITHUB`.\n * @type {String}\n */","meta":{"range":[45659,45675],"filename":"Docma.js","lineno":1165,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003442","name":"STATIC","type":"Literal","value":"static"}},"description":"Indicates that SPA will be hosted as static HTML files.\n Similar to `Docma.ServerType.GITHUB`.","type":{"names":["String"]},"name":"STATIC","longname":"Docma.ServerType.STATIC","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"static","$longname":"Docma.ServerType.STATIC","$kind":"property","$docmaLink":"api/#Docma.ServerType.STATIC"},{"comment":"/**\n * Indicates that SPA will be hosted on a Windows server.\n * @type {String}\n */","meta":{"range":[45783,45801],"filename":"Docma.js","lineno":1170,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003444","name":"WINDOWS","type":"Literal","value":"windows"}},"description":"Indicates that SPA will be hosted on a Windows server.","type":{"names":["String"]},"name":"WINDOWS","longname":"Docma.ServerType.WINDOWS","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"windows","$longname":"Docma.ServerType.WINDOWS","$kind":"property","$docmaLink":"api/#Docma.ServerType.WINDOWS"}]},{"comment":"/**\n * This class is useful for template authors only.
\n *\n * Class that provides template information and methods for supporting the\n * documentation build process.\n *\n * You should not instantiate this class directly with a `new` operator. Docma\n * passes an instance of this class to your template module as the first\n * argument; when the end-user builds their documentation.\n *\n * See {@link templates/guide/|Creating Docma Templates}.\n * You can also use {@link cli/#docma-template-init--path-|Docma CLI}\n * to initialize a new Docma template project. i.e. `docma template init`. This will\n * generate most files required to author a template; including a main JS file for\n * your module; as shown below in the example.\n *\n * @class\n * @name Docma.Template\n * @since 2.0.0\n *\n * @example Custom template module implementation \n * module.exports = (template, modules) => {\n *\n * // Docma also passes some useful modules (which it already uses internally);\n * // so you don't have to add them to your template module as dependencies.\n * // modules: _ (Lodash), Promise (Bluebird), fs (fs-extra), dust, HtmlParser, utils\n * const { Promise } = modules;\n *\n * template.mainHTML = 'index.html';\n *\n * template.defaultOptions = {\n * // whatever options your template has...\n * title: 'Docs',\n * searchEnabled: true\n * };\n *\n * template.preBuild(() => {\n * // Do some stuff —before— Docma builds documentation for the end-user...\n * return Promise.resolve();\n * });\n *\n * template.postBuild(() => {\n * // Do some stuff —after— the build completes...\n * return Promise.resolve();\n * });\n * };\n */","meta":{"filename":"Template.js","lineno":18,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"This class is useful for template authors only.
\n\n Class that provides template information and methods for supporting the\n documentation build process.\n\n You should not instantiate this class directly with a `new` operator. Docma\n passes an instance of this class to your template module as the first\n argument; when the end-user builds their documentation.\n\n See {@link templates/guide/|Creating Docma Templates}.\n You can also use {@link cli/#docma-template-init--path-|Docma CLI}\n to initialize a new Docma template project. i.e. `docma template init`. This will\n generate most files required to author a template; including a main JS file for\n your module; as shown below in the example.","kind":"class","name":"Template","since":"2.0.0","examples":["Custom template module implementation \n module.exports = (template, modules) => {\n\n // Docma also passes some useful modules (which it already uses internally);\n // so you don't have to add them to your template module as dependencies.\n // modules: _ (Lodash), Promise (Bluebird), fs (fs-extra), dust, HtmlParser, utils\n const { Promise } = modules;\n\n template.mainHTML = 'index.html';\n\n template.defaultOptions = {\n // whatever options your template has...\n title: 'Docs',\n searchEnabled: true\n };\n\n template.preBuild(() => {\n // Do some stuff —before— Docma builds documentation for the end-user...\n return Promise.resolve();\n });\n\n template.postBuild(() => {\n // Do some stuff —after— the build completes...\n return Promise.resolve();\n });\n };"],"memberof":"Docma","longname":"Docma.Template","scope":"static","$longname":"Docma.Template","$kind":"class","$docmaLink":"api/#Docma.Template","$members":[{"comment":"/**\n * Gets the author of the template.\n * @type {String}\n * @name Docma.Template#author\n */","meta":{"filename":"Template.js","lineno":176,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the author of the template.","type":{"names":["String"]},"name":"author","memberof":"Docma.Template","longname":"Docma.Template#author","scope":"instance","kind":"member","$longname":"Docma.Template#author","$kind":"property","$docmaLink":"api/#Docma.Template#author"},{"comment":"/**\n * Gets the build configuration used when building documentation with this\n * template.\n * @type {Docma~BuildConfiguration}\n * @name Docma.Template#buildConfig\n */","meta":{"filename":"Template.js","lineno":221,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the build configuration used when building documentation with this\n template.","type":{"names":["Docma~BuildConfiguration"]},"name":"buildConfig","memberof":"Docma.Template","longname":"Docma.Template#buildConfig","scope":"instance","kind":"member","$longname":"Docma.Template#buildConfig","$kind":"property","$docmaLink":"api/#Docma.Template#buildConfig"},{"comment":"/**\n * Gets the simple debugger/logger used by Dogma.\n * @type {Docma~Debug}\n * @name Docma.Template#debug\n */","meta":{"filename":"Template.js","lineno":231,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the simple debugger/logger used by Dogma.","type":{"names":["Docma~Debug"]},"name":"debug","memberof":"Docma.Template","longname":"Docma.Template#debug","scope":"instance","kind":"member","$longname":"Docma.Template#debug","$kind":"property","$docmaLink":"api/#Docma.Template#debug"},{"comment":"/**\n * Gets or sets the default options of the template.\n * Default options can be set within the module main JS file or via\n * `docmaTemplate.defaultOptions` within template's package.json.\n * @type {Object}\n * @name Docma.Template#defaultOptions\n */","meta":{"filename":"Template.js","lineno":240,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets or sets the default options of the template.\n Default options can be set within the module main JS file or via\n `docmaTemplate.defaultOptions` within template's package.json.","type":{"names":["Object"]},"name":"defaultOptions","memberof":"Docma.Template","longname":"Docma.Template#defaultOptions","scope":"instance","kind":"member","$longname":"Docma.Template#defaultOptions","$kind":"property","$docmaLink":"api/#Docma.Template#defaultOptions"},{"comment":"/**\n * Gets the description of the template.\n * @type {String}\n * @name Docma.Template#description\n */","meta":{"filename":"Template.js","lineno":138,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the description of the template.","type":{"names":["String"]},"name":"description","memberof":"Docma.Template","longname":"Docma.Template#description","scope":"instance","kind":"member","$longname":"Docma.Template#description","$kind":"property","$docmaLink":"api/#Docma.Template#description"},{"comment":"/**\n * Gets the dirname of the template.\n * @type {String}\n * @name Docma.Template#dirname\n */","meta":{"filename":"Template.js","lineno":203,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the dirname of the template.","type":{"names":["String"]},"name":"dirname","memberof":"Docma.Template","longname":"Docma.Template#dirname","scope":"instance","kind":"member","$longname":"Docma.Template#dirname","$kind":"property","$docmaLink":"api/#Docma.Template#dirname"},{"comment":"/**\n * Gets Docma version, template is built with.\n * @type {String}\n * @name Docma.Template#docmaVersion\n */","meta":{"filename":"Template.js","lineno":156,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets Docma version, template is built with.","type":{"names":["String"]},"name":"docmaVersion","memberof":"Docma.Template","longname":"Docma.Template#docmaVersion","scope":"instance","kind":"member","$longname":"Docma.Template#docmaVersion","$kind":"property","$docmaLink":"api/#Docma.Template#docmaVersion"},{"comment":"/**\n * Convenience method for joining and getting the destination path within\n * build (output) directory for the given string(s).\n * @name Docma.Template#getDestPath\n * @function\n * @param {...String} [args=\"\"] - String arguments of path sections.\n * @returns {String} -\n */","meta":{"filename":"Template.js","lineno":328,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Convenience method for joining and getting the destination path within\n build (output) directory for the given string(s).","name":"getDestPath","kind":"function","params":[{"type":{"names":["String"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"String arguments of path sections.","name":"args"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"Docma.Template","longname":"Docma.Template#getDestPath","scope":"instance","$longname":"Docma.Template#getDestPath","$kind":"method","$docmaLink":"api/#Docma.Template#getDestPath"},{"comment":"/**\n * Convenience method for joining and getting the source path within\n * `/template` directory for the given string(s).\n * @name Docma.Template#getSrcPath\n * @function\n * @param {...String} [args=\"\"] - String arguments of path sections.\n * @returns {String} -\n */","meta":{"filename":"Template.js","lineno":316,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Convenience method for joining and getting the source path within\n `/template` directory for the given string(s).","name":"getSrcPath","kind":"function","params":[{"type":{"names":["String"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"String arguments of path sections.","name":"args"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"Docma.Template","longname":"Docma.Template#getSrcPath","scope":"instance","$longname":"Docma.Template#getSrcPath","$kind":"method","$docmaLink":"api/#Docma.Template#getSrcPath"},{"comment":"/**\n * Gets or sets array of ignored files when building documentation with\n * this template. Ignored files can be set within the module main JS file\n * or via `docmaTemplate.ignore` within template's package.json.\n * @type {Array}\n * @name Docma.Template#ignore\n */","meta":{"filename":"Template.js","lineno":291,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets or sets array of ignored files when building documentation with\n this template. Ignored files can be set within the module main JS file\n or via `docmaTemplate.ignore` within template's package.json.","type":{"names":["Array"]},"name":"ignore","memberof":"Docma.Template","longname":"Docma.Template#ignore","scope":"instance","kind":"member","$longname":"Docma.Template#ignore","$kind":"property","$docmaLink":"api/#Docma.Template#ignore"},{"comment":"/**\n * Gets the license of the template.\n * @type {String}\n * @name Docma.Template#license\n */","meta":{"filename":"Template.js","lineno":185,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the license of the template.","type":{"names":["String"]},"name":"license","memberof":"Docma.Template","longname":"Docma.Template#license","scope":"instance","kind":"member","$longname":"Docma.Template#license","$kind":"property","$docmaLink":"api/#Docma.Template#license"},{"comment":"/**\n * Outputs a data log to the console. For more logger/debugger methods, use\n * {@link api/#Docma.Template#debug|`#debug`} object.\n * @name Docma.Template#log\n * @function\n * @param {...String} [args=\"\"] - String arguments to be logged.\n */","meta":{"filename":"Template.js","lineno":305,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Outputs a data log to the console. For more logger/debugger methods, use\n {@link api/#Docma.Template#debug|`#debug`} object.","name":"log","kind":"function","params":[{"type":{"names":["String"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"String arguments to be logged.","name":"args"}],"memberof":"Docma.Template","longname":"Docma.Template#log","scope":"instance","$longname":"Docma.Template#log","$kind":"method","$docmaLink":"api/#Docma.Template#log"},{"comment":"/**\n * Gets or sets the main HTML file (name) of the template.\n * Main HTML file can be set within the module main JS file or via\n * `docmaTemplate.mainHTML` within template's package.json.\n * @type {String}\n * @name Docma.Template#mainHTML\n */","meta":{"filename":"Template.js","lineno":275,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets or sets the main HTML file (name) of the template.\n Main HTML file can be set within the module main JS file or via\n `docmaTemplate.mainHTML` within template's package.json.","type":{"names":["String"]},"name":"mainHTML","memberof":"Docma.Template","longname":"Docma.Template#mainHTML","scope":"instance","kind":"member","$longname":"Docma.Template#mainHTML","$kind":"property","$docmaLink":"api/#Docma.Template#mainHTML"},{"comment":"/**\n * Gets the name of the template.\n * @type {String}\n * @name Docma.Template#name\n */","meta":{"filename":"Template.js","lineno":129,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the name of the template.","type":{"names":["String"]},"name":"name","memberof":"Docma.Template","longname":"Docma.Template#name","scope":"instance","kind":"member","$longname":"Docma.Template#name","$kind":"property","$docmaLink":"api/#Docma.Template#name"},{"comment":"/**\n * Gets or sets the template options set by the user when building\n * documentation with this template.\n * @type {Object}\n * @name Docma.Template#options\n */","meta":{"filename":"Template.js","lineno":262,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets or sets the template options set by the user when building\n documentation with this template.","type":{"names":["Object"]},"name":"options","memberof":"Docma.Template","longname":"Docma.Template#options","scope":"instance","kind":"member","$longname":"Docma.Template#options","$kind":"property","$docmaLink":"api/#Docma.Template#options"},{"comment":"/**\n * Gets the path of the template.\n * @type {String}\n * @name Docma.Template#path\n */","meta":{"filename":"Template.js","lineno":194,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the path of the template.","type":{"names":["String"]},"name":"path","memberof":"Docma.Template","longname":"Docma.Template#path","scope":"instance","kind":"member","$longname":"Docma.Template#path","$kind":"property","$docmaLink":"api/#Docma.Template#path"},{"comment":"/**\n * Gets the package.json contents of the template.\n * @type {Object}\n * @name Docma.Template#pkg\n */","meta":{"filename":"Template.js","lineno":120,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the package.json contents of the template.","type":{"names":["Object"]},"name":"pkg","memberof":"Docma.Template","longname":"Docma.Template#pkg","scope":"instance","kind":"member","$longname":"Docma.Template#pkg","$kind":"property","$docmaLink":"api/#Docma.Template#pkg"},{"comment":"/**\n * Sets a post-build processor function that is ran right after Docma build\n * completes.\n * @name Docma.Template#postBuild\n * @function\n * @param {Function} fn - Processor function. You can return a `Promise` if\n * this is an async operation.\n */","meta":{"filename":"Template.js","lineno":352,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Sets a post-build processor function that is ran right after Docma build\n completes.","name":"postBuild","kind":"function","params":[{"type":{"names":["function"]},"description":"Processor function. You can return a `Promise` if\n this is an async operation.","name":"fn"}],"memberof":"Docma.Template","longname":"Docma.Template#postBuild","scope":"instance","$longname":"Docma.Template#postBuild","$kind":"method","$docmaLink":"api/#Docma.Template#postBuild"},{"comment":"/**\n * Sets a pre-build processor function that is ran right before Docma build\n * starts.\n * @name Docma.Template#preBuild\n * @function\n * @param {Function} fn - Processor function. You can return a `Promise` if\n * this is an async operation.\n */","meta":{"filename":"Template.js","lineno":340,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Sets a pre-build processor function that is ran right before Docma build\n starts.","name":"preBuild","kind":"function","params":[{"type":{"names":["function"]},"description":"Processor function. You can return a `Promise` if\n this is an async operation.","name":"fn"}],"memberof":"Docma.Template","longname":"Docma.Template#preBuild","scope":"instance","$longname":"Docma.Template#preBuild","$kind":"method","$docmaLink":"api/#Docma.Template#preBuild"},{"comment":"/**\n * Gets Docma version (range) supported by this template.\n * This is set via `peerDependencies` in package.json.\n * If omitted, returns `\">=2.0.0\"`.\n * @type {String}\n * @name Docma.Template#supportedDocmaVersion\n */","meta":{"filename":"Template.js","lineno":165,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets Docma version (range) supported by this template.\n This is set via `peerDependencies` in package.json.\n If omitted, returns `\">=2.0.0\"`.","type":{"names":["String"]},"name":"supportedDocmaVersion","memberof":"Docma.Template","longname":"Docma.Template#supportedDocmaVersion","scope":"instance","kind":"member","$longname":"Docma.Template#supportedDocmaVersion","$kind":"property","$docmaLink":"api/#Docma.Template#supportedDocmaVersion"},{"comment":"/**\n * Gets the path of the template directory within the template.\n * @type {String}\n * @name Docma.Template#templateDir\n */","meta":{"filename":"Template.js","lineno":212,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the path of the template directory within the template.","type":{"names":["String"]},"name":"templateDir","memberof":"Docma.Template","longname":"Docma.Template#templateDir","scope":"instance","kind":"member","$longname":"Docma.Template#templateDir","$kind":"property","$docmaLink":"api/#Docma.Template#templateDir"},{"comment":"/**\n * Gets the version of the template.\n * @type {String}\n * @name Docma.Template#version\n */","meta":{"filename":"Template.js","lineno":147,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the version of the template.","type":{"names":["String"]},"name":"version","memberof":"Docma.Template","longname":"Docma.Template#version","scope":"instance","kind":"member","$longname":"Docma.Template#version","$kind":"property","$docmaLink":"api/#Docma.Template#version"}]},{"comment":"/**\n * This class is useful for template authors only.
\n *\n * Class that runs diagnostics on a target Docma template by analyzing\n * the file structure, validating package metadata and testing with the\n * template builder.\n *\n * @class\n * @name TemplateDoctor\n * @memberof Docma\n * @since 2.0.0\n */","meta":{"filename":"TemplateDoctor.js","lineno":70,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"This class is useful for template authors only.
\n\n Class that runs diagnostics on a target Docma template by analyzing\n the file structure, validating package metadata and testing with the\n template builder.","kind":"class","name":"TemplateDoctor","memberof":"Docma","since":"2.0.0","scope":"static","longname":"Docma.TemplateDoctor","$longname":"Docma.TemplateDoctor","$kind":"class","$docmaLink":"api/#Docma.TemplateDoctor","$members":[{"comment":"/**\n * Analyzes the Docma template and collects diagnostics information on the\n * template structure, package health and builder initialization.\n * @name Docma.TemplateDoctor#diagnose\n * @method\n *\n * @returns {Object} - Diagnostics data.\n */","meta":{"filename":"TemplateDoctor.js","lineno":327,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Analyzes the Docma template and collects diagnostics information on the\n template structure, package health and builder initialization.","name":"diagnose","kind":"function","returns":[{"type":{"names":["Object"]},"description":"- Diagnostics data."}],"memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#diagnose","scope":"instance","$longname":"Docma.TemplateDoctor#diagnose","$kind":"method","$docmaLink":"api/#Docma.TemplateDoctor#diagnose"},{"comment":"/**\n * Gets the diagnostics data object that contains the results.\n * @type {Object}\n * @name Docma.TemplateDoctor#diagnostics\n */","meta":{"filename":"TemplateDoctor.js","lineno":145,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the diagnostics data object that contains the results.","type":{"names":["Object"]},"name":"diagnostics","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#diagnostics","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#diagnostics","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#diagnostics"},{"comment":"/**\n * Gets the package.json contents of the Docma template anayzed.\n * @type {Object}\n * @name Docma.TemplateDoctor#pkg\n */","meta":{"filename":"TemplateDoctor.js","lineno":117,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the package.json contents of the Docma template anayzed.","type":{"names":["Object"]},"name":"pkg","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#pkg","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#pkg","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#pkg"},{"comment":"/**\n * Resets the state of the TemplateDoctor instance, cleaning up\n * previous diagnosis information and data. (Note that settings are not\n * reset.)\n * @name Docma.TemplateDoctor#reset\n * @method\n */","meta":{"filename":"TemplateDoctor.js","lineno":382,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Resets the state of the TemplateDoctor instance, cleaning up\n previous diagnosis information and data. (Note that settings are not\n reset.)","name":"reset","kind":"function","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#reset","scope":"instance","$longname":"Docma.TemplateDoctor#reset","$kind":"method","$docmaLink":"api/#Docma.TemplateDoctor#reset"},{"comment":"/**\n * Gets or sets the diagnostics settings.\n * @type {Object}\n * @name Docma.TemplateDoctor#settings\n */","meta":{"filename":"TemplateDoctor.js","lineno":154,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets or sets the diagnostics settings.","type":{"names":["Object"]},"name":"settings","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#settings","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#settings","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#settings"},{"comment":"/**\n * Gets the template instance created while diagnosing. In other words,\n * template instance is only available after `.diagnose()` is called.\n * @type {Docma.Template}\n * @name Docma.TemplateDoctor#template\n */","meta":{"filename":"TemplateDoctor.js","lineno":135,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the template instance created while diagnosing. In other words,\n template instance is only available after `.diagnose()` is called.","type":{"names":["Docma.Template"]},"name":"template","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#template","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#template","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#template"},{"comment":"/**\n * Gets the name of the Docma template.\n * @type {String}\n * @name Docma.TemplateDoctor#templateName\n */","meta":{"filename":"TemplateDoctor.js","lineno":126,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{}},"description":"Gets the name of the Docma template.","type":{"names":["String"]},"name":"templateName","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#templateName","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#templateName","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#templateName"}],"$constructor":{"comment":"/**\n * Initializes a new instance of `Docma.TemplateDoctor`.\n * @constructs Docma.TemplateDoctor\n *\n * @param {String} templatePath - Path of the template to be diagnosed.\n * @param {Object} [settings={}] - Diagnose settings.\n * @param {Boolean} [settings.quiet=true] - Whether not to log\n * diagnostics information to console.\n * @param {Boolean} [settings.stopOnFirstFailure=false] - Whether\n * to stop on first failure.\n */","meta":{"range":[2756,3391],"filename":"TemplateDoctor.js","lineno":94,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100004298","name":"TemplateDoctor","type":"MethodDefinition","paramnames":["templatePath","settings"]},"vars":{"":null}},"description":"Initializes a new instance of `Docma.TemplateDoctor`.","alias":"Docma.TemplateDoctor","kind":"class","params":[{"type":{"names":["String"]},"description":"Path of the template to be diagnosed.","name":"templatePath"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":"{}","description":"Diagnose settings.","name":"settings"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether not to log\n diagnostics information to console.","name":"settings.quiet"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether\n to stop on first failure.","name":"settings.stopOnFirstFailure"}],"name":"TemplateDoctor","longname":"Docma.TemplateDoctor","memberof":"Docma","scope":"static","$longname":"Docma.TemplateDoctor","$kind":"constructor","$docmaLink":"api/#Docma.TemplateDoctor"}},{"comment":"/**\n * Initializes a new instance of `Docma.Template`.\n * @hideconstructor\n *\n * @param {Object} params - Template parameters.\n * @param {Object} params.modulePath - Resolved path of the template\n * module.\n * @param {Object} params.buildConfig - Docma build configuration (that\n * also includes template configuration).\n * @param {String} params.docmaVersion - Current Docma version.\n * @param {Function} params.fnLog - Log function to be used within the\n * template module.\n */","meta":{"range":[2614,3982],"filename":"Template.js","lineno":79,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib","code":{"id":"astnode100003503","name":"Template","type":"MethodDefinition","paramnames":["params"]},"vars":{"":null}},"description":"Initializes a new instance of `Docma.Template`.","hideconstructor":true,"params":[{"type":{"names":["Object"]},"description":"Template parameters.","name":"params"},{"type":{"names":["Object"]},"description":"Resolved path of the template\n module.","name":"params.modulePath"},{"type":{"names":["Object"]},"description":"Docma build configuration (that\n also includes template configuration).","name":"params.buildConfig"},{"type":{"names":["String"]},"description":"Current Docma version.","name":"params.docmaVersion"},{"type":{"names":["function"]},"description":"Log function to be used within the\n template module.","name":"params.fnLog"}],"name":"Template","longname":"Template","kind":"class","scope":"global","$longname":"Template","$kind":"constructor","$docmaLink":"api/#Template","$hide":true}],"symbols":["Docma","Docma#build","Docma~BuildConfiguration","Docma.create","Docma.Debug","Docma.RouteType","Docma.RoutingMethod","Docma.ServerType","Docma.Template","Docma.Template#author","Docma.Template#buildConfig","Docma.Template#debug","Docma.Template#defaultOptions","Docma.Template#description","Docma.Template#dirname","Docma.Template#docmaVersion","Docma.Template#getDestPath","Docma.Template#getSrcPath","Docma.Template#ignore","Docma.Template#license","Docma.Template#log","Docma.Template#mainHTML","Docma.Template#name","Docma.Template#options","Docma.Template#path","Docma.Template#pkg","Docma.Template#postBuild","Docma.Template#preBuild","Docma.Template#supportedDocmaVersion","Docma.Template#templateDir","Docma.Template#version","Docma.TemplateDoctor","Docma.TemplateDoctor#diagnose","Docma.TemplateDoctor#diagnostics","Docma.TemplateDoctor#pkg","Docma.TemplateDoctor#reset","Docma.TemplateDoctor#settings","Docma.TemplateDoctor#template","Docma.TemplateDoctor#templateName","Template"]},"web":{"documentation":[{"comment":"/**\n * Docma (web) core.\n *\n * When you build the documentation with a template, `docma-web.js` will be\n * generated (and linked in the main HTML); which is the core engine for the\n * documentation web app. This will include everything the app needs such as\n * the documentation data, compiled partials, dustjs engine, etc...\n *\n * An instance of this object is globally accessible within the generated SPA\n * as docma. Note that the size of the `docma-web.js` script depends primarily\n * on the generated documentation data.
\n *\n * @class\n * @name DocmaWeb\n * @hideconstructor\n * @emits DocmaWeb~event:ready\n * @emits DocmaWeb~event:render\n * @emits DocmaWeb~event:route\n * @emits DocmaWeb~event:navigate\n */","meta":{"filename":"DocmaWeb.js","lineno":17,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Docma (web) core.\n\n When you build the documentation with a template, `docma-web.js` will be\n generated (and linked in the main HTML); which is the core engine for the\n documentation web app. This will include everything the app needs such as\n the documentation data, compiled partials, dustjs engine, etc...\n\n An instance of this object is globally accessible within the generated SPA\n as docma. Note that the size of the `docma-web.js` script depends primarily\n on the generated documentation data.
","kind":"class","name":"DocmaWeb","hideconstructor":true,"fires":["DocmaWeb~event:ready","DocmaWeb~event:render","DocmaWeb~event:route","DocmaWeb~event:navigate"],"longname":"DocmaWeb","scope":"global","$longname":"DocmaWeb","$kind":"class","$docmaLink":"api/web/#DocmaWeb","$members":[{"comment":"/**\n * Adds a new Dust filter.\n * @chainable\n * @see {@link templates/filters/|Existing Docma (Dust) filters}\n * @see {@link https://www.dustjs.com/docs/filter-api|Dust Filter API}\n *\n * @param {String} name - Name of the filter to be added.\n * @param {Function} fn - Filter function.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n * @throws {Error} - If a filter with the given name already exists.\n */","meta":{"range":[23763,23970],"filename":"DocmaWeb.js","lineno":711,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000990","name":"DocmaWeb.prototype.addFilter","type":"FunctionExpression","paramnames":["name","fn"]},"vars":{"dust.filters[undefined]":"dust.filters[undefined]"}},"description":"Adds a new Dust filter.","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"see":["{@link templates/filters/|Existing Docma (Dust) filters}","{@link https://www.dustjs.com/docs/filter-api|Dust Filter API}"],"params":[{"type":{"names":["String"]},"description":"Name of the filter to be added.","name":"name"},{"type":{"names":["function"]},"description":"Filter function.","name":"fn"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"exceptions":[{"type":{"names":["Error"]},"description":"- If a filter with the given name already exists."}],"name":"addFilter","longname":"DocmaWeb#addFilter","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#addFilter","$kind":"method","$docmaLink":"api/web/#DocmaWeb#addFilter"},{"comment":"/**\n *\tHash-map of JSDoc documentation outputs.\n *\tEach key is the name of an API (formed by grouped Javascript files).\n *\te.g. `docma.apis[\"some-api\"]`\n *\n * Unnamed documentation data (consisting of ungrouped Javascript files) can be\n * accessed via `docma.apis._def_`.\n *\n *\tEach value is an `Object` with the following signature:\n *\t`{ documentation:Array, symbols:Array }`. `documentation` is the actual\n *\tJSDoc data, and `symbols` is a flat array of symbol names.\n *\n * See {@link api/#Docma~BuildConfiguration|build configuration} for more\n * details on how Javascript files can be grouped (and named) to form separate\n * API documentations and SPA routes.
\n *\n * @name DocmaWeb#apis\n * @type {Object}\n *\n * @example Programmatic access to documentation data \n * // output ungrouped (unnamed) API documentation data\n * console.log(docma.apis._def_.documentation);\n * console.log(docma.apis._def_.symbols); // flat list of symbol names\n * // output one of the grouped (named) API documentation data\n * console.log(docma.apis['my-scondary-api'].documentation);\n *\n * @example Usage in a Dust partial \n * \n * {#documentation}\n * {longname}
\n * {description}
\n *
\n * {/documentation}\n */","meta":{"filename":"DocmaWeb.js","lineno":79,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Hash-map of JSDoc documentation outputs.\n\tEach key is the name of an API (formed by grouped Javascript files).\n\te.g. `docma.apis[\"some-api\"]`\n\n Unnamed documentation data (consisting of ungrouped Javascript files) can be\n accessed via `docma.apis._def_`.\n\n\tEach value is an `Object` with the following signature:\n\t`{ documentation:Array, symbols:Array }`. `documentation` is the actual\n\tJSDoc data, and `symbols` is a flat array of symbol names.\n\n See {@link api/#Docma~BuildConfiguration|build configuration} for more\n details on how Javascript files can be grouped (and named) to form separate\n API documentations and SPA routes.
","name":"apis","type":{"names":["Object"]},"examples":["Programmatic access to documentation data \n // output ungrouped (unnamed) API documentation data\n console.log(docma.apis._def_.documentation);\n console.log(docma.apis._def_.symbols); // flat list of symbol names\n // output one of the grouped (named) API documentation data\n console.log(docma.apis['my-scondary-api'].documentation);\n\n ","Usage in a Dust partial \n \n {#documentation}\n {longname}
\n {description}
\n
\n {/documentation}"],"memberof":"DocmaWeb","longname":"DocmaWeb#apis","scope":"instance","kind":"member","$longname":"DocmaWeb#apis","$kind":"property","$docmaLink":"api/web/#DocmaWeb#apis"},{"comment":"/**\n * Provides configuration data of the generated SPA, which is originally set\n * at build-time, by the user.\n * See {@link api/#Docma~BuildConfiguration|build configuration} for more\n * details on how these settings take affect.\n * @name DocmaWeb#app\n * @type {Object}\n *\n * @property {String} title\n * Document title for the main file of the generated app.\n * (Value of the `<title/>` tag.)\n * @property {Array} meta\n * Array of arbitrary objects set for main document meta (tags).\n * @property {String} base\n * Base path of the generated web app.\n * @property {String} entrance\n * Name of the initial content displayed, when the web app is first\n * loaded.\n * @property {String|Object} routing\n * Routing settings for the generated SPA.\n * @property {String} server\n * Server/host type of the generated SPA.\n */","meta":{"filename":"DocmaWeb.js","lineno":49,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Provides configuration data of the generated SPA, which is originally set\n at build-time, by the user.\n See {@link api/#Docma~BuildConfiguration|build configuration} for more\n details on how these settings take affect.","name":"app","type":{"names":["Object"]},"properties":[{"type":{"names":["String"]},"description":"Base path of the generated web app.","name":"base"},{"type":{"names":["String"]},"description":"Name of the initial content displayed, when the web app is first\n loaded.","name":"entrance"},{"type":{"names":["Array"]},"description":"Array of arbitrary objects set for main document meta (tags).","name":"meta"},{"type":{"names":["String","Object"]},"description":"Routing settings for the generated SPA.","name":"routing"},{"type":{"names":["String"]},"description":"Server/host type of the generated SPA.","name":"server"},{"type":{"names":["String"]},"description":"Document title for the main file of the generated app.\n (Value of the `<title/>` tag.)","name":"title"}],"memberof":"DocmaWeb","longname":"DocmaWeb#app","scope":"instance","kind":"member","$longname":"DocmaWeb#app","$kind":"property","$docmaLink":"api/web/#DocmaWeb#app"},{"comment":"/**\n * Creates a SPA route information object for the given route name and type.\n *\n * @param {String} name\n * Name of the route.\n * @param {String} type\n * Type of the SPA route. See {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`}\n * enumeration for possible values.\n *\n * @returns {DocmaWeb.Route} - Route instance.\n */","meta":{"range":[24966,25073],"filename":"DocmaWeb.js","lineno":754,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001064","name":"DocmaWeb.prototype.createRoute","type":"FunctionExpression","paramnames":["name","type"]}},"description":"Creates a SPA route information object for the given route name and type.","params":[{"type":{"names":["String"]},"description":"Name of the route.","name":"name"},{"type":{"names":["String"]},"description":"Type of the SPA route. See {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`}\n enumeration for possible values.","name":"type"}],"returns":[{"type":{"names":["DocmaWeb.Route"]},"description":"- Route instance."}],"name":"createRoute","longname":"DocmaWeb#createRoute","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#createRoute","$kind":"method","$docmaLink":"api/web/#DocmaWeb#createRoute"},{"comment":"/**\n * Gets the route information for the current rendered content being\n * displayed.\n *\n * @name DocmaWeb#currentRoute\n * @type {DocmaWeb.Route}\n * @readonly\n *\n * @property {String} type\n * Type of the current route. If a generated JSDoc API\n * documentation is being displayed, this is set to `\"api\"`.\n * If any other HTML content (such as a converted markdown) is\n * being displayed; this is set to `\"content\"`.\n * @property {String} name\n * Name of the current route. For `api` routes, this is the name\n * of the grouped JS files parsed. If no name is given, this is\n * set to `\"_def_\"` by default. For `content` routes, this is\n * either the custom name given at build-time or, by default; the\n * name of the generated HTML file; lower-cased, without the\n * extension. e.g. `\"README.md\"` will have the route name\n * `\"readme\"` after the build.\n * @property {String} path\n * Path of the current route.\n */","meta":{"filename":"DocmaWeb.js","lineno":257,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the route information for the current rendered content being\n displayed.","name":"currentRoute","type":{"names":["DocmaWeb.Route"]},"readonly":true,"properties":[{"type":{"names":["String"]},"description":"Name of the current route. For `api` routes, this is the name\n of the grouped JS files parsed. If no name is given, this is\n set to `\"_def_\"` by default. For `content` routes, this is\n either the custom name given at build-time or, by default; the\n name of the generated HTML file; lower-cased, without the\n extension. e.g. `\"README.md\"` will have the route name\n `\"readme\"` after the build.","name":"name"},{"type":{"names":["String"]},"description":"Path of the current route.","name":"path"},{"type":{"names":["String"]},"description":"Type of the current route. If a generated JSDoc API\n documentation is being displayed, this is set to `\"api\"`.\n If any other HTML content (such as a converted markdown) is\n being displayed; this is set to `\"content\"`.","name":"type"}],"memberof":"DocmaWeb","longname":"DocmaWeb#currentRoute","scope":"instance","kind":"member","$longname":"DocmaWeb#currentRoute","$kind":"property","$docmaLink":"api/web/#DocmaWeb#currentRoute"},{"comment":"/**\n *\tJSDoc documentation data for the current API route.\n *\tIf current route is not an API route, this will be `null`.\n *\n * See {@link api/#Docma~BuildConfiguration|build configuration} for more\n * details on how Javascript files can be grouped (and named) to form\n * separate API documentations and SPA routes.
\n *\n * @name DocmaWeb#documentation\n * @type {Array}\n *\n * @example Output current API documentation data \n * if (docma.currentRoute.type === 'api') {\n * \tconsole.log(docma.documentation);\n * }\n *\n * @example Usage in (Dust) partial \n * {#documentation}\n * {longname}
\n * {description}
\n *
\n * {/documentation}\n */","meta":{"filename":"DocmaWeb.js","lineno":288,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"JSDoc documentation data for the current API route.\n\tIf current route is not an API route, this will be `null`.\n\n See {@link api/#Docma~BuildConfiguration|build configuration} for more\n details on how Javascript files can be grouped (and named) to form\n separate API documentations and SPA routes.
","name":"documentation","type":{"names":["Array"]},"examples":["Output current API documentation data \n if (docma.currentRoute.type === 'api') {\n \tconsole.log(docma.documentation);\n }\n\n ","Usage in (Dust) partial \n {#documentation}\n {longname}
\n {description}
\n
\n {/documentation}"],"memberof":"DocmaWeb","longname":"DocmaWeb#documentation","scope":"instance","kind":"member","$longname":"DocmaWeb#documentation","$kind":"property","$docmaLink":"api/web/#DocmaWeb#documentation"},{"comment":"/**\n * Outputs an error log to the browser console. (Unlike `console.error()`) this\n * method respects `debug` option of Docma build configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[19634,19759],"filename":"DocmaWeb.js","lineno":580,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000691","name":"DocmaWeb.prototype.error","type":"FunctionExpression","paramnames":[]}},"description":"Outputs an error log to the browser console. (Unlike `console.error()`) this\n method respects `debug` option of Docma build configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"error","longname":"DocmaWeb#error","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#error","$kind":"method","$docmaLink":"api/web/#DocmaWeb#error"},{"comment":"/**\n * Docma SPA events enumeration.\n * @enum {String}\n */","meta":{"range":[15063,15610],"filename":"DocmaWeb.js","lineno":419,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000477","name":"DocmaWeb.Event","type":"ObjectExpression","value":"{\"Ready\":\"ready\",\"Render\":\"render\",\"Route\":\"route\",\"Navigate\":\"navigate\"}","paramnames":[]}},"description":"Docma SPA events enumeration.","kind":"member","isEnum":true,"type":{"names":["String"]},"name":"Event","longname":"DocmaWeb.Event","memberof":"DocmaWeb","scope":"static","properties":[{"comment":"/**\n * Emitted either when the route is changed or navigated to a\n * bookmark (i.e. hashchange).\n * @type {String}\n */","meta":{"range":[15587,15607],"filename":"DocmaWeb.js","lineno":440,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000488","name":"Navigate","type":"Literal","value":"navigate"}},"description":"Emitted either when the route is changed or navigated to a\n bookmark (i.e. hashchange).","type":{"names":["String"]},"name":"Navigate","longname":"DocmaWeb.Event.Navigate","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"navigate"},{"comment":"/**\n * Emitted when Docma is ready and the initial content is rendered.\n * @type {String}\n */","meta":{"range":[15198,15212],"filename":"DocmaWeb.js","lineno":424,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000482","name":"Ready","type":"Literal","value":"ready"}},"description":"Emitted when Docma is ready and the initial content is rendered.","type":{"names":["String"]},"name":"Ready","longname":"DocmaWeb.Event.Ready","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"ready"},{"comment":"/**\n * Emitted when page content (a Dust partial) is rendered.\n * @type {String}\n */","meta":{"range":[15321,15337],"filename":"DocmaWeb.js","lineno":429,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000484","name":"Render","type":"Literal","value":"render"}},"description":"Emitted when page content (a Dust partial) is rendered.","type":{"names":["String"]},"name":"Render","longname":"DocmaWeb.Event.Render","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"render"},{"comment":"/**\n * Emitted when SPA route is changed.\n * @type {String}\n */","meta":{"range":[15425,15439],"filename":"DocmaWeb.js","lineno":434,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000486","name":"Route","type":"Literal","value":"route"}},"description":"Emitted when SPA route is changed.","type":{"names":["String"]},"name":"Route","longname":"DocmaWeb.Event.Route","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"route"}],"$longname":"DocmaWeb.Event","$kind":"enum","$docmaLink":"api/web/#DocmaWeb.Event","$members":[{"comment":"/**\n * Emitted either when the route is changed or navigated to a\n * bookmark (i.e. hashchange).\n * @type {String}\n */","meta":{"range":[15587,15607],"filename":"DocmaWeb.js","lineno":440,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000488","name":"Navigate","type":"Literal","value":"navigate"}},"description":"Emitted either when the route is changed or navigated to a\n bookmark (i.e. hashchange).","type":{"names":["String"]},"name":"Navigate","longname":"DocmaWeb.Event.Navigate","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"navigate","$longname":"DocmaWeb.Event.Navigate","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Navigate"},{"comment":"/**\n * Emitted when Docma is ready and the initial content is rendered.\n * @type {String}\n */","meta":{"range":[15198,15212],"filename":"DocmaWeb.js","lineno":424,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000482","name":"Ready","type":"Literal","value":"ready"}},"description":"Emitted when Docma is ready and the initial content is rendered.","type":{"names":["String"]},"name":"Ready","longname":"DocmaWeb.Event.Ready","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"ready","$longname":"DocmaWeb.Event.Ready","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Ready"},{"comment":"/**\n * Emitted when page content (a Dust partial) is rendered.\n * @type {String}\n */","meta":{"range":[15321,15337],"filename":"DocmaWeb.js","lineno":429,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000484","name":"Render","type":"Literal","value":"render"}},"description":"Emitted when page content (a Dust partial) is rendered.","type":{"names":["String"]},"name":"Render","longname":"DocmaWeb.Event.Render","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"render","$longname":"DocmaWeb.Event.Render","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Render"},{"comment":"/**\n * Emitted when SPA route is changed.\n * @type {String}\n */","meta":{"range":[15425,15439],"filename":"DocmaWeb.js","lineno":434,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000486","name":"Route","type":"Literal","value":"route"}},"description":"Emitted when SPA route is changed.","type":{"names":["String"]},"name":"Route","longname":"DocmaWeb.Event.Route","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"route","$longname":"DocmaWeb.Event.Route","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Route"}]},{"comment":"/**\n * Fired either when the route is changed or navigated to a bookmark\n * (i.e. on hash-change). If the route does not exist (404), `currentRoute`\n * will be `null`.\n *\n * @event DocmaWeb~event:navigate\n * @type {DocmaWeb.Route}\n *\n * @example\n * docma.on('navigate', function (currentRoute) {\n * if (currentRoute) {\n * // do stuff...\n * }\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":399,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Fired either when the route is changed or navigated to a bookmark\n (i.e. on hash-change). If the route does not exist (404), `currentRoute`\n will be `null`.","kind":"event","name":"event:navigate","type":{"names":["DocmaWeb.Route"]},"examples":["docma.on('navigate', function (currentRoute) {\n if (currentRoute) {\n // do stuff...\n }\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:navigate","scope":"inner","$longname":"DocmaWeb~event:navigate","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:navigate"},{"comment":"/**\n * Fired when Docma is ready and the initial content is rendered.\n * This is only fired once.\n *\n * @event DocmaWeb~event:ready\n *\n * @example\n * docma.once('ready', function () {\n * // do stuff...\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":355,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Fired when Docma is ready and the initial content is rendered.\n This is only fired once.","kind":"event","name":"event:ready","examples":["docma.once('ready', function () {\n // do stuff...\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:ready","scope":"inner","$longname":"DocmaWeb~event:ready","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:ready"},{"comment":"/**\n * Fired when page content (a Dust partial) is rendered. The emitted obeject is\n * `currentRoute`. If the route does not exist (404), `currentRoute` will be\n * `null`. This is fired after the `route` event.\n *\n * @event DocmaWeb~event:render\n * @type {DocmaWeb.Route}\n *\n * @example\n * docma.on('render', function (currentRoute) {\n * if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n * // do stuff...\n * }\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":367,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Fired when page content (a Dust partial) is rendered. The emitted obeject is\n `currentRoute`. If the route does not exist (404), `currentRoute` will be\n `null`. This is fired after the `route` event.","kind":"event","name":"event:render","type":{"names":["DocmaWeb.Route"]},"examples":["docma.on('render', function (currentRoute) {\n if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n // do stuff...\n }\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:render","scope":"inner","$longname":"DocmaWeb~event:render","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:render"},{"comment":"/**\n * Fired when SPA route is changed. The emitted obeject is `currentRoute`. If\n * the route does not exist (404), `currentRoute` will be `null`. This is fired\n * before the `render` event.\n *\n * @event DocmaWeb~event:route\n * @type {DocmaWeb.Route}\n *\n * @example\n * docma.on('route', function (currentRoute) {\n * if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n * // do stuff...\n * }\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":383,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Fired when SPA route is changed. The emitted obeject is `currentRoute`. If\n the route does not exist (404), `currentRoute` will be `null`. This is fired\n before the `render` event.","kind":"event","name":"event:route","type":{"names":["DocmaWeb.Route"]},"examples":["docma.on('route', function (currentRoute) {\n if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n // do stuff...\n }\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:route","scope":"inner","$longname":"DocmaWeb~event:route","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:route"},{"comment":"/**\n * Asynchronously fetches (text) content from the given URL via an\n * `XmlHttpRequest`. Note that the URL has to be in the same-origin, for\n * this to work.\n *\n * @param {String} url\n * URL to be fetched.\n * @param {Function} callback\n * Function to be executed when the content is fetched; with the\n * following signature: `function (status, responseText) { .. }`\n */","meta":{"range":[28420,28850],"filename":"DocmaWeb.js","lineno":865,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001374","name":"DocmaWeb.prototype.fetch","type":"FunctionExpression","paramnames":["url","callback"]},"vars":{"xhr":"DocmaWeb#fetch~xhr","self":"DocmaWeb#fetch~self","xhr.onreadystatechange":"DocmaWeb#fetch~xhr.onreadystatechange","":null}},"description":"Asynchronously fetches (text) content from the given URL via an\n `XmlHttpRequest`. Note that the URL has to be in the same-origin, for\n this to work.","params":[{"type":{"names":["String"]},"description":"URL to be fetched.","name":"url"},{"type":{"names":["function"]},"description":"Function to be executed when the content is fetched; with the\n following signature: `function (status, responseText) { .. }`","name":"callback"}],"name":"fetch","longname":"DocmaWeb#fetch","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#fetch","$kind":"method","$docmaLink":"api/web/#DocmaWeb#fetch"},{"comment":"/**\n * Checks whether a Dust filter with the given name already exists.\n * @param {String} name - Name of the filter to be checked.\n * @returns {Boolean} -\n */","meta":{"range":[24421,24527],"filename":"DocmaWeb.js","lineno":735,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001045","name":"DocmaWeb.prototype.filterExists","type":"FunctionExpression","paramnames":["name"]}},"description":"Checks whether a Dust filter with the given name already exists.","params":[{"type":{"names":["String"]},"description":"Name of the filter to be checked.","name":"name"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"filterExists","longname":"DocmaWeb#filterExists","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#filterExists","$kind":"method","$docmaLink":"api/web/#DocmaWeb#filterExists"},{"comment":"/**\n * Gets Docma content DOM element that the HTML content will be loaded\n * into. This should be called for `docma-content` partial.\n *\n * @returns {HTMLElement} - Docma content DOM element.\n */","meta":{"range":[20467,21090],"filename":"DocmaWeb.js","lineno":611,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000764","name":"DocmaWeb.prototype.getContentElem","type":"FunctionExpression","paramnames":[]},"vars":{"dContent":"DocmaWeb#getContentElem~dContent"}},"description":"Gets Docma content DOM element that the HTML content will be loaded\n into. This should be called for `docma-content` partial.","returns":[{"type":{"names":["HTMLElement"]},"description":"- Docma content DOM element."}],"name":"getContentElem","longname":"DocmaWeb#getContentElem","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#getContentElem","$kind":"method","$docmaLink":"api/web/#DocmaWeb#getContentElem"},{"comment":"/**\n * Gets Docma main DOM element which the Dust templates will be rendered\n * into.\n *\n * @returns {HTMLElement} - Docma main DOM element.\n */","meta":{"range":[19990,20264],"filename":"DocmaWeb.js","lineno":595,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000717","name":"DocmaWeb.prototype.getDocmaElem","type":"FunctionExpression","paramnames":[]},"vars":{"docmaElem":"DocmaWeb#getDocmaElem~docmaElem"}},"description":"Gets Docma main DOM element which the Dust templates will be rendered\n into.","returns":[{"type":{"names":["HTMLElement"]},"description":"- Docma main DOM element."}],"name":"getDocmaElem","longname":"DocmaWeb#getDocmaElem","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#getDocmaElem","$kind":"method","$docmaLink":"api/web/#DocmaWeb#getDocmaElem"},{"comment":"/**\n * Outputs an informational log to the browser console. (Unlike\n * `console.info()`) this method respects `debug` option of Docma build\n * configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[18966,19089],"filename":"DocmaWeb.js","lineno":560,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000639","name":"DocmaWeb.prototype.info","type":"FunctionExpression","paramnames":[]}},"description":"Outputs an informational log to the browser console. (Unlike\n `console.info()`) this method respects `debug` option of Docma build\n configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"info","longname":"DocmaWeb#info","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#info","$kind":"method","$docmaLink":"api/web/#DocmaWeb#info"},{"comment":"/**\n * Loads the given HTML content into `docma-content` element. This is a\n * low-level method. Typically you would not need to use this.\n *\n * @param {String} html - Content to be loaded.\n */","meta":{"range":[21290,21837],"filename":"DocmaWeb.js","lineno":635,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000813","name":"DocmaWeb.prototype.loadContent","type":"FunctionExpression","paramnames":["html"]},"vars":{"dContent":"DocmaWeb#loadContent~dContent","dContent.innerHTML":"DocmaWeb#loadContent~dContent.innerHTML"}},"description":"Loads the given HTML content into `docma-content` element. This is a\n low-level method. Typically you would not need to use this.","params":[{"type":{"names":["String"]},"description":"Content to be loaded.","name":"html"}],"name":"loadContent","longname":"DocmaWeb#loadContent","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#loadContent","$kind":"method","$docmaLink":"api/web/#DocmaWeb#loadContent"},{"comment":"/**\n * Similar to `window.location` but with differences and additional\n * information.\n *\n * @name DocmaWeb#location\n * @type {Object}\n * @readonly\n *\n * @property {String} origin\n * Gets the protocol, hostname and port number of the current URL.\n * @property {String} host\n * Gets the hostname and port number of the current URL.\n * @property {String} hostname\n * Gets the domain name of the web host.\n * @property {String} protocol\n * Gets the web protocol used, without `:` suffix.\n * @property {String} href\n * Gets the href (URL) of the current location.\n * @property {String} entrance\n * Gets the application entrance route, which is set at Docma build-time.\n * @property {String} base\n * Gets the base path of the application URL, which is set at Docma build-time.\n * @property {String} fullpath\n * Gets the path and filename of the current URL.\n * @property {String} pathname\n * Gets the path and filename of the current URL, without the base.\n * @property {String} path\n * Gets the path, filename and query-string of the current URL, without the base.\n * @property {String} hash\n * Gets the anchor `#` of the current URL, without `#` prefix.\n * @property {String} query\n * Gets the querystring part of the current URL, without `?` prefix.\n * @property {Function} getQuery()\n * Gets the value of the given querystring parameter.\n */","meta":{"filename":"DocmaWeb.js","lineno":178,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Similar to `window.location` but with differences and additional\n information.","name":"location","type":{"names":["Object"]},"readonly":true,"properties":[{"type":{"names":["String"]},"description":"Gets the base path of the application URL, which is set at Docma build-time.","name":"base"},{"type":{"names":["String"]},"description":"Gets the application entrance route, which is set at Docma build-time.","name":"entrance"},{"type":{"names":["String"]},"description":"Gets the path and filename of the current URL.","name":"fullpath"},{"type":{"names":["function"]},"description":"Gets the value of the given querystring parameter.","name":"getQuery()"},{"type":{"names":["String"]},"description":"Gets the anchor `#` of the current URL, without `#` prefix.","name":"hash"},{"type":{"names":["String"]},"description":"Gets the hostname and port number of the current URL.","name":"host"},{"type":{"names":["String"]},"description":"Gets the domain name of the web host.","name":"hostname"},{"type":{"names":["String"]},"description":"Gets the href (URL) of the current location.","name":"href"},{"type":{"names":["String"]},"description":"Gets the protocol, hostname and port number of the current URL.","name":"origin"},{"type":{"names":["String"]},"description":"Gets the path, filename and query-string of the current URL, without the base.","name":"path"},{"type":{"names":["String"]},"description":"Gets the path and filename of the current URL, without the base.","name":"pathname"},{"type":{"names":["String"]},"description":"Gets the web protocol used, without `:` suffix.","name":"protocol"},{"type":{"names":["String"]},"description":"Gets the querystring part of the current URL, without `?` prefix.","name":"query"}],"memberof":"DocmaWeb","longname":"DocmaWeb#location","scope":"instance","kind":"member","$longname":"DocmaWeb#location","$kind":"property","$docmaLink":"api/web/#DocmaWeb#location"},{"comment":"/**\n * Outputs a general log to the browser console. (Unlike `console.log()`) this\n * method respects `debug` option of Docma build configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[18623,18744],"filename":"DocmaWeb.js","lineno":549,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000613","name":"DocmaWeb.prototype.log","type":"FunctionExpression","paramnames":[]}},"description":"Outputs a general log to the browser console. (Unlike `console.log()`) this\n method respects `debug` option of Docma build configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"log","longname":"DocmaWeb#log","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#log","$kind":"method","$docmaLink":"api/web/#DocmaWeb#log"},{"comment":"/**\n * Removes the given listener from the specified event.\n * @name DocmaWeb#off\n * @function\n * @alias DocmaWeb#removeListener\n * @chainable\n *\n * @param {String} eventName\n * Name of the event to remove the listener from.\n * See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.\n * @param {Function} listener\n * Function to be removed from the event.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n */","meta":{"filename":"DocmaWeb.js","lineno":504,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Removes the given listener from the specified event.","name":"off","kind":"function","alias":"DocmaWeb#removeListener","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the event to remove the listener from.\n See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.","name":"eventName"},{"type":{"names":["function"]},"description":"Function to be removed from the event.","name":"listener"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"memberof":"DocmaWeb","longname":"DocmaWeb#off","scope":"instance","$longname":"DocmaWeb#off","$kind":"method","$docmaLink":"api/web/#DocmaWeb#off"},{"comment":"/**\n * Adds a listener function to the specified event.\n * Note that the listener will not be added if it is a duplicate.\n * If the listener returns true then it will be removed after it is called.\n * @name DocmaWeb#on\n * @function\n * @alias DocmaWeb#addListener\n * @chainable\n *\n * @param {String} eventName\n * Name of the event to attach the listener to.\n * See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.\n * @param {Function} listener\n * Function to be called when the event is emitted. If the function\n * returns true then it will be removed after calling.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n *\n * @example\n * docma.on('render', function (currentRoute) {\n * \tif (!currentRoute) {\n * \t\tconsole.log('Not found!');\n * \t\treturn;\n * \t}\n * \tif (currentRoute.type === docma.Route.Type.API) {\n * \t\tconsole.log('This is an API route.')\n * \t}\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":443,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Adds a listener function to the specified event.\n Note that the listener will not be added if it is a duplicate.\n If the listener returns true then it will be removed after it is called.","name":"on","kind":"function","alias":"DocmaWeb#addListener","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the event to attach the listener to.\n See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.","name":"eventName"},{"type":{"names":["function"]},"description":"Function to be called when the event is emitted. If the function\n returns true then it will be removed after calling.","name":"listener"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"examples":["docma.on('render', function (currentRoute) {\n \tif (!currentRoute) {\n \t\tconsole.log('Not found!');\n \t\treturn;\n \t}\n \tif (currentRoute.type === docma.Route.Type.API) {\n \t\tconsole.log('This is an API route.')\n \t}\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb#on","scope":"instance","$longname":"DocmaWeb#on","$kind":"method","$docmaLink":"api/web/#DocmaWeb#on"},{"comment":"/**\n * Adds a listener that will be automatically removed after its first\n * execution.\n * @name DocmaWeb#once\n * @function\n * @alias DocmaWeb#addOnceListener\n * @chainable\n *\n * @param {String} eventName\n * Name of the event to attach the listener to.\n * See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.\n * @param {Function} listener\n * Function to be called when the event is emitted.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n *\n * @example\n * docma.once('ready', function () {\n * \tconsole.log('Docma is ready!');\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":478,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Adds a listener that will be automatically removed after its first\n execution.","name":"once","kind":"function","alias":"DocmaWeb#addOnceListener","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the event to attach the listener to.\n See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.","name":"eventName"},{"type":{"names":["function"]},"description":"Function to be called when the event is emitted.","name":"listener"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"examples":["docma.once('ready', function () {\n \tconsole.log('Docma is ready!');\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb#once","scope":"instance","$longname":"DocmaWeb#once","$kind":"method","$docmaLink":"api/web/#DocmaWeb#once"},{"comment":"/**\n * Removes an existing Dust filter.\n * @chainable\n * @param {String} name - Name of the filter to be removed.\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n */","meta":{"range":[24154,24255],"filename":"DocmaWeb.js","lineno":725,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001026","name":"DocmaWeb.prototype.removeFilter","type":"FunctionExpression","paramnames":["name"]}},"description":"Removes an existing Dust filter.","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the filter to be removed.","name":"name"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"name":"removeFilter","longname":"DocmaWeb#removeFilter","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#removeFilter","$kind":"method","$docmaLink":"api/web/#DocmaWeb#removeFilter"},{"comment":"/**\n * Renders content into docma-main element, by the given route information.\n *\n * If the content is empty or `\"api\"`, we'll render the `docma-api` Dust\n * template. Otherwise, (e.g. `\"readme\"`) we'll render `docma-content` Dust\n * template, then fetch `content/readme.html` and load it in the `docma-main`\n * element.\n *\n * Note that rendering and the callback will be cancelled if the given\n * content is the latest content rendered.
\n *\n * @param {DocmaWeb.Route} routeInfo - Route information of the page to be\n * rendered.\n * @param {Function} [callback] - Function to be executed when the rendering is\n * complete. `function (httpStatus:Number) { .. }`\n * @returns {void}\n * @emits DocmaWeb~event:render\n */","meta":{"range":[29608,30949],"filename":"DocmaWeb.js","lineno":897,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001451","name":"DocmaWeb.prototype.render","type":"FunctionExpression","paramnames":["routeInfo","callback"]},"vars":{"this._.currentRoute":"DocmaWeb#render#_.currentRoute","isCbFn":"DocmaWeb#render~isCbFn","self":"DocmaWeb#render~self","":null}},"description":"Renders content into docma-main element, by the given route information.\n\n If the content is empty or `\"api\"`, we'll render the `docma-api` Dust\n template. Otherwise, (e.g. `\"readme\"`) we'll render `docma-content` Dust\n template, then fetch `content/readme.html` and load it in the `docma-main`\n element.\n\n Note that rendering and the callback will be cancelled if the given\n content is the latest content rendered.
","params":[{"type":{"names":["DocmaWeb.Route"]},"description":"Route information of the page to be\n rendered.","name":"routeInfo"},{"type":{"names":["function"]},"optional":true,"description":"Function to be executed when the rendering is\n complete. `function (httpStatus:Number) { .. }`","name":"callback"}],"returns":[{"type":{"names":["void"]}}],"fires":["DocmaWeb~event:render"],"name":"render","longname":"DocmaWeb#render","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#render","$kind":"method","$docmaLink":"api/web/#DocmaWeb#render"},{"comment":"/**\n * @classdesc Creates SPA route information object for the given route name\n * and type. You cannot directly construct an instance of this class via\n * `new` operator. Use {@link #DocmaWeb#createRoute|`DocmaWeb#createRoute`}\n * method instead.\n * @class\n * @hideconstructor\n *\n * @param {DocmaWeb} docma `DocmaWeb` instance.\n * @param {String} name Name of the route.\n * @param {String} type Type of the SPA route. See\n * {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n * for possible values.\n */","meta":{"range":[957,1763],"filename":"DocmaWeb.Route.js","lineno":28,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001638","name":"DocmaWeb.Route","type":"FunctionExpression","paramnames":["docma","name","type"]},"vars":{"this._docma":"DocmaWeb.Route#_docma","name":"DocmaWeb.Route~name","info":"DocmaWeb.Route~info"}},"classdesc":"Creates SPA route information object for the given route name\n and type. You cannot directly construct an instance of this class via\n `new` operator. Use {@link #DocmaWeb#createRoute|`DocmaWeb#createRoute`}\n method instead.","kind":"class","hideconstructor":true,"params":[{"type":{"names":["DocmaWeb"]},"description":"`DocmaWeb` instance.","name":"docma"},{"type":{"names":["String"]},"description":"Name of the route.","name":"name"},{"type":{"names":["String"]},"description":"Type of the SPA route. See\n {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n for possible values.","name":"type"}],"name":"Route","longname":"DocmaWeb.Route","memberof":"DocmaWeb","scope":"static","$longname":"DocmaWeb.Route","$kind":"class","$docmaLink":"api/web/#DocmaWeb.Route","$members":[{"comment":"/**\n * Applies the route to the application.\n * @emits DocmaWeb~event:route\n * @param {Function} [cb] - Callback function to be executed after route is\n * rendered.\n * @returns {DocmaWeb.Route} - The route instance for chaining.\n */","meta":{"range":[5988,6596],"filename":"DocmaWeb.Route.js","lineno":205,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001843","name":"DocmaWeb.Route.prototype.apply","type":"FunctionExpression","paramnames":["cb"]},"vars":{"this._docma._.documentation":"DocmaWeb.Route#_docma._.documentation","this._docma._.symbols":"DocmaWeb.Route#_docma._.symbols"}},"description":"Applies the route to the application.","fires":["DocmaWeb~event:route"],"params":[{"type":{"names":["function"]},"optional":true,"description":"Callback function to be executed after route is\n rendered.","name":"cb"}],"returns":[{"type":{"names":["DocmaWeb.Route"]},"description":"- The route instance for chaining."}],"name":"apply","longname":"DocmaWeb.Route#apply","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#apply","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#apply"},{"comment":"/**\n * Gets the path of the generated content (HTML) file.\n * If this is an API route, `contentPath` is `null`.\n * @name DocmaWeb.Route#contentPath\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":128,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the path of the generated content (HTML) file.\n If this is an API route, `contentPath` is `null`.","name":"contentPath","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#contentPath","kind":"member","$longname":"DocmaWeb.Route#contentPath","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#contentPath"},{"comment":"/**\n * Checks whether the route actually exists.\n * @returns {Boolean} -\n */","meta":{"range":[5070,5148],"filename":"DocmaWeb.Route.js","lineno":175,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001768","name":"DocmaWeb.Route.prototype.exists","type":"FunctionExpression","paramnames":[]}},"description":"Checks whether the route actually exists.","returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"exists","longname":"DocmaWeb.Route#exists","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#exists","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#exists"},{"comment":"/**\n * Gets the ID of the route. A route ID consists of the route type and the\n * name; delimited via a colon. e.g. `api:web`.\n * @name DocmaWeb.Route#id\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":120,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the ID of the route. A route ID consists of the route type and the\n name; delimited via a colon. e.g. `api:web`.","name":"id","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#id","kind":"member","$longname":"DocmaWeb.Route#id","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#id"},{"comment":"/**\n * Checks whether the route is currently being viewed.\n * @param {DocmaWeb.Route} routeInfo - Object to be checked.\n * @returns {Boolean} -\n */","meta":{"range":[5642,5747],"filename":"DocmaWeb.Route.js","lineno":194,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001822","name":"DocmaWeb.Route.prototype.isCurrent","type":"FunctionExpression","paramnames":[]}},"description":"Checks whether the route is currently being viewed.","params":[{"type":{"names":["DocmaWeb.Route"]},"description":"Object to be checked.","name":"routeInfo"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"isCurrent","longname":"DocmaWeb.Route#isCurrent","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#isCurrent","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#isCurrent"},{"comment":"/**\n * Checks whether the route is equal to the given route.\n * @param {DocmaWeb.Route} routeInfo - Route to be checked against.\n * @returns {Boolean} -\n */","meta":{"range":[5311,5488],"filename":"DocmaWeb.Route.js","lineno":184,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001785","name":"DocmaWeb.Route.prototype.isEqualTo","type":"FunctionExpression","paramnames":["routeInfo"]}},"description":"Checks whether the route is equal to the given route.","params":[{"type":{"names":["DocmaWeb.Route"]},"description":"Route to be checked against.","name":"routeInfo"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"isEqualTo","longname":"DocmaWeb.Route#isEqualTo","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#isEqualTo","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#isEqualTo"},{"comment":"/**\n * Gets the name of the SPA route, which is either set by the user when\n * building the documentation; or auto-generated from the source file name.\n * @name DocmaWeb.Route#name\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":163,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the name of the SPA route, which is either set by the user when\n building the documentation; or auto-generated from the source file name.","name":"name","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#name","kind":"member","$longname":"DocmaWeb.Route#name","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#name"},{"comment":"/**\n * Gets the URL path of the SPA route. For example, if SPA route method is\n * `query`, the URL path for a route named `guide` will be `?content=guide`.\n * If routing method is `path` it will be `guide/`.\n * @name DocmaWeb.Route#path\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":136,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the URL path of the SPA route. For example, if SPA route method is\n `query`, the URL path for a route named `guide` will be `?content=guide`.\n If routing method is `path` it will be `guide/`.","name":"path","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#path","kind":"member","$longname":"DocmaWeb.Route#path","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#path"},{"comment":"/**\n * Gets the type of the source which this route is generated from. See\n * {@link #DocmaWeb.Route.SourceType|`DocmaWeb.Route.SourceType`} enumeration\n * for possible values.\n * @name DocmaWeb.Route#sourceType\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":154,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the type of the source which this route is generated from. See\n {@link #DocmaWeb.Route.SourceType|`DocmaWeb.Route.SourceType`} enumeration\n for possible values.","name":"sourceType","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#sourceType","kind":"member","$longname":"DocmaWeb.Route#sourceType","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#sourceType"},{"comment":"/**\n * Enumerates the source types that a SPA route is generated from.\n * @name DocmaWeb.Route.SourceType\n * @enum {String}\n * @static\n * @readonly\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":92,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Enumerates the source types that a SPA route is generated from.","name":"SourceType","kind":"member","isEnum":true,"type":{"names":["String"]},"scope":"static","readonly":true,"memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route.SourceType","$longname":"DocmaWeb.Route.SourceType","$kind":"enum","$docmaLink":"api/web/#DocmaWeb.Route.SourceType","$members":[{"comment":"/**\n * Indicates that the documentation route is generated from HTML\n * source.\n * @type {String}\n */","meta":{"range":[3620,3632],"filename":"DocmaWeb.Route.js","lineno":117,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001765","name":"HTML","type":"Literal","value":"html"}},"description":"Indicates that the documentation route is generated from HTML\n source.","type":{"names":["String"]},"name":"HTML","longname":"DocmaWeb.Route.SourceType.HTML","kind":"member","memberof":"DocmaWeb.Route.SourceType","scope":"static","$longname":"DocmaWeb.Route.SourceType.HTML","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.SourceType.HTML"},{"comment":"/**\n * Indicates that the documentation route is generated from Javascript\n * source.\n * @type {String}\n */","meta":{"range":[3338,3346],"filename":"DocmaWeb.Route.js","lineno":105,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001761","name":"JS","type":"Literal","value":"js"}},"description":"Indicates that the documentation route is generated from Javascript\n source.","type":{"names":["String"]},"name":"JS","longname":"DocmaWeb.Route.SourceType.JS","kind":"member","memberof":"DocmaWeb.Route.SourceType","scope":"static","$longname":"DocmaWeb.Route.SourceType.JS","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.SourceType.JS"},{"comment":"/**\n * Indicates that the documentation route is generated from markdown\n * source.\n * @type {String}\n */","meta":{"range":[3481,3489],"filename":"DocmaWeb.Route.js","lineno":111,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001763","name":"MD","type":"Literal","value":"md"}},"description":"Indicates that the documentation route is generated from markdown\n source.","type":{"names":["String"]},"name":"MD","longname":"DocmaWeb.Route.SourceType.MD","kind":"member","memberof":"DocmaWeb.Route.SourceType","scope":"static","$longname":"DocmaWeb.Route.SourceType.MD","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.SourceType.MD"}]},{"comment":"/**\n * Gets the string representation of the route.\n * @returns {String} -\n */","meta":{"range":[6680,6886],"filename":"DocmaWeb.Route.js","lineno":224,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001960","name":"DocmaWeb.Route.prototype.toString","type":"FunctionExpression","paramnames":[]},"vars":{"o":"DocmaWeb.Route#toString~o","":null}},"description":"Gets the string representation of the route.","returns":[{"type":{"names":["String"]},"description":"-"}],"name":"toString","longname":"DocmaWeb.Route#toString","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#toString","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#toString"},{"comment":"/**\n * Gets the type of the generated SPA route. See\n * {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n * for possible values.\n * @name DocmaWeb.Route#type\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":145,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the type of the generated SPA route. See\n {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n for possible values.","name":"type","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#type","kind":"member","$longname":"DocmaWeb.Route#type","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#type"},{"comment":"/**\n * Enumerates the Docma SPA route types.\n * @name DocmaWeb.Route.Type\n * @enum {String}\n * @static\n * @readonly\n *\n * @example When `docma.app.routing.method` is `\"query\"` \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ ?api\n * api web ?api=web\n * content templates ?content=templates\n * content guide ?content=guide\n *\n * @example When `docma.app.routing.method` is `\"path\"` \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ api/\n * api web api/web/\n * content templates templates/\n * content guide guide/\n *\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":52,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Enumerates the Docma SPA route types.","name":"Type","kind":"member","isEnum":true,"type":{"names":["String"]},"scope":"static","readonly":true,"examples":["When `docma.app.routing.method` is `\"query\"` \n type name path\n ------- ---------------- --------------------------\n api _def_ ?api\n api web ?api=web\n content templates ?content=templates\n content guide ?content=guide\n\n ","When `docma.app.routing.method` is `\"path\"` \n type name path\n ------- ---------------- --------------------------\n api _def_ api/\n api web api/web/\n content templates templates/\n content guide guide/"],"memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route.Type","$longname":"DocmaWeb.Route.Type","$kind":"enum","$docmaLink":"api/web/#DocmaWeb.Route.Type","$members":[{"comment":"/**\n * Indicates that the route is for API documentation content, generated\n * from one or more Javascript files.\n * @type {String}\n */","meta":{"range":[2756,2766],"filename":"DocmaWeb.Route.js","lineno":82,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001737","name":"API","type":"Literal","value":"api"}},"description":"Indicates that the route is for API documentation content, generated\n from one or more Javascript files.","type":{"names":["String"]},"name":"API","longname":"DocmaWeb.Route.Type.API","kind":"member","memberof":"DocmaWeb.Route.Type","scope":"static","$longname":"DocmaWeb.Route.Type.API","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.Type.API"},{"comment":"/**\n * Indicates that the route is for other content, such as parsed HTML\n * files or HTML files generated from markdown.\n * @type {String}\n */","meta":{"range":[2939,2957],"filename":"DocmaWeb.Route.js","lineno":88,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001739","name":"CONTENT","type":"Literal","value":"content"}},"description":"Indicates that the route is for other content, such as parsed HTML\n files or HTML files generated from markdown.","type":{"names":["String"]},"name":"CONTENT","longname":"DocmaWeb.Route.Type.CONTENT","kind":"member","memberof":"DocmaWeb.Route.Type","scope":"static","$longname":"DocmaWeb.Route.Type.CONTENT","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.Type.CONTENT"}]}]},{"comment":"/**\n * Array of available SPA routes of the documentation.\n * This is created at build-time and defined via the `src` param of the\n * {@link api/#Docma~BuildConfiguration|build configuration}.\n *\n * @name DocmaWeb#routes\n * @type {Array}\n *\n * @see {@link #DocmaWeb.Route|`DocmaWeb.Route`}\n */","meta":{"filename":"DocmaWeb.js","lineno":123,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Array of available SPA routes of the documentation.\n This is created at build-time and defined via the `src` param of the\n {@link api/#Docma~BuildConfiguration|build configuration}.","name":"routes","type":{"names":["Array"]},"see":["{@link #DocmaWeb.Route|`DocmaWeb.Route`}"],"memberof":"DocmaWeb","longname":"DocmaWeb#routes","scope":"instance","kind":"member","$longname":"DocmaWeb#routes","$kind":"property","$docmaLink":"api/web/#DocmaWeb#routes"},{"comment":"/**\n *\tA flat array of JSDoc documentation symbol names. This is useful for\n *\tbuilding menus, etc... If current route is not an API route, this will\n *\tbe `null`.\n *\n * See {@link api/docma#Docma~BuildConfiguration|build configuration} for more\n * details on how Javascript files can be grouped (and named) to form\n * separate API documentations and SPA routes.
\n *\n * @name DocmaWeb#symbols\n * @type {Array}\n *\n * @example Usage in (Dust) partial \n * \n */","meta":{"filename":"DocmaWeb.js","lineno":318,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"A flat array of JSDoc documentation symbol names. This is useful for\n\tbuilding menus, etc... If current route is not an API route, this will\n\tbe `null`.\n\n See {@link api/docma#Docma~BuildConfiguration|build configuration} for more\n details on how Javascript files can be grouped (and named) to form\n separate API documentations and SPA routes.
","name":"symbols","type":{"names":["Array"]},"examples":["Usage in (Dust) partial \n "],"memberof":"DocmaWeb","longname":"DocmaWeb#symbols","scope":"instance","kind":"member","$longname":"DocmaWeb#symbols","$kind":"property","$docmaLink":"api/web/#DocmaWeb#symbols"},{"comment":"/**\n * Provides template specific configuration data.\n * This is also useful within the Dust partials of the Docma template.\n * @name DocmaWeb#template\n * @type {Object}\n *\n * @property {Object} options - Docma template options. Defined at build-time,\n * by the user.\n * @property {String} name\n * Name of the Docma template.\n * @property {String} version\n * Version of the Docma template.\n * @property {String} author\n * Author information for the Docma template.\n * @property {String} license\n * License information for the Docma template.\n * @property {String} mainHTML\n * Name of the main file of the template. i.e. `index.html`\n *\n * @example Usage in a Dust partial \n * \n * {?template.options.someOption}\n * Displayed if someOption is true.\n * {/template.options.someOption}\n * \n * \n */","meta":{"filename":"DocmaWeb.js","lineno":140,"columnno":4,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Provides template specific configuration data.\n This is also useful within the Dust partials of the Docma template.","name":"template","type":{"names":["Object"]},"properties":[{"type":{"names":["String"]},"description":"Author information for the Docma template.","name":"author"},{"type":{"names":["String"]},"description":"License information for the Docma template.","name":"license"},{"type":{"names":["String"]},"description":"Name of the main file of the template. i.e. `index.html`","name":"mainHTML"},{"type":{"names":["String"]},"description":"Name of the Docma template.","name":"name"},{"type":{"names":["Object"]},"description":"Docma template options. Defined at build-time,\n by the user.","name":"options"},{"type":{"names":["String"]},"description":"Version of the Docma template.","name":"version"}],"examples":["Usage in a Dust partial \n \n {?template.options.someOption}\n Displayed if someOption is true.\n {/template.options.someOption}\n \n "],"memberof":"DocmaWeb","longname":"DocmaWeb#template","scope":"instance","kind":"member","$longname":"DocmaWeb#template","$kind":"property","$docmaLink":"api/web/#DocmaWeb#template"},{"comment":"/**\n * Utilities for inspecting JSDoc documentation and symbols; and parsing\n * documentation data into proper HTML.\n * See {@link api/web/utils|`DocmaWeb.Utils` documentation}.\n * @type {Object}\n * @namespace\n */","meta":{"range":[31253,31275],"filename":"DocmaWeb.js","lineno":945,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100001627","name":"DocmaWeb.Utils","type":"Identifier","value":"Utils","paramnames":[]}},"description":"Utilities for inspecting JSDoc documentation and symbols; and parsing\n documentation data into proper HTML.\n See {@link api/web/utils|`DocmaWeb.Utils` documentation}.","type":{"names":["Object"]},"kind":"namespace","name":"Utils","longname":"DocmaWeb.Utils","memberof":"DocmaWeb","scope":"static","$longname":"DocmaWeb.Utils","$kind":"namespace","$docmaLink":"api/web/#DocmaWeb.Utils"},{"comment":"/**\n * Gets Docma version which the documentation is built with.\n * @name DocmaWeb#version\n * @type {String}\n */","meta":{"filename":"DocmaWeb.js","lineno":11,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets Docma version which the documentation is built with.","name":"version","type":{"names":["String"]},"memberof":"DocmaWeb","longname":"DocmaWeb#version","scope":"instance","kind":"member","$longname":"DocmaWeb#version","$kind":"property","$docmaLink":"api/web/#DocmaWeb#version"},{"comment":"/**\n * Outputs a warning log to the browser console. (Unlike `console.warn()`) this\n * method respects `debug` option of Docma build configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[19300,19423],"filename":"DocmaWeb.js","lineno":570,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{"id":"astnode100000665","name":"DocmaWeb.prototype.warn","type":"FunctionExpression","paramnames":[]}},"description":"Outputs a warning log to the browser console. (Unlike `console.warn()`) this\n method respects `debug` option of Docma build configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"warn","longname":"DocmaWeb#warn","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#warn","$kind":"method","$docmaLink":"api/web/#DocmaWeb#warn"}]}],"symbols":["DocmaWeb","DocmaWeb#addFilter","DocmaWeb#apis","DocmaWeb#app","DocmaWeb#createRoute","DocmaWeb#currentRoute","DocmaWeb#documentation","DocmaWeb#error","DocmaWeb.Event","DocmaWeb~event:navigate","DocmaWeb~event:ready","DocmaWeb~event:render","DocmaWeb~event:route","DocmaWeb#fetch","DocmaWeb#filterExists","DocmaWeb#getContentElem","DocmaWeb#getDocmaElem","DocmaWeb#info","DocmaWeb#loadContent","DocmaWeb#location","DocmaWeb#log","DocmaWeb#off","DocmaWeb#on","DocmaWeb#once","DocmaWeb#removeFilter","DocmaWeb#render","DocmaWeb.Route","DocmaWeb.Route#apply","DocmaWeb.Route#contentPath","DocmaWeb.Route#exists","DocmaWeb.Route#id","DocmaWeb.Route#isCurrent","DocmaWeb.Route#isEqualTo","DocmaWeb.Route#name","DocmaWeb.Route#path","DocmaWeb.Route#sourceType","DocmaWeb.Route.SourceType","DocmaWeb.Route#toString","DocmaWeb.Route#type","DocmaWeb.Route.Type","DocmaWeb#routes","DocmaWeb#symbols","DocmaWeb#template","DocmaWeb.Utils","DocmaWeb#version","DocmaWeb#warn"]},"web/utils":{"documentation":[{"comment":"/**\n * Docma (web) core class.\n * See {@link api/web|documentation}.\n * @name DocmaWeb\n * @class\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":6,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Docma (web) core class.\n See {@link api/web|documentation}.","name":"DocmaWeb","kind":"class","longname":"DocmaWeb","scope":"global","$longname":"DocmaWeb","$kind":"class","$docmaLink":"api/web/utils/#DocmaWeb","$members":[{"comment":"/**\n * Utilities for inspecting JSDoc documentation and symbols; and parsing\n * documentation data into proper HTML.\n * @name DocmaWeb.Utils\n * @type {Object}\n * @namespace\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":18,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Utilities for inspecting JSDoc documentation and symbols; and parsing\n documentation data into proper HTML.","name":"Utils","type":{"names":["Object"]},"kind":"namespace","memberof":"DocmaWeb","longname":"DocmaWeb.Utils","scope":"static","$longname":"DocmaWeb.Utils","$kind":"namespace","$docmaLink":"api/web/utils/#DocmaWeb.Utils","$members":[{"comment":"/**\n * DOM utilities.\n * @name DocmaWeb.Utils.DOM\n * @namespace\n * @type {Object}\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1563,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"DOM utilities.","name":"DOM","kind":"namespace","type":{"names":["Object"]},"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.DOM","scope":"static","$longname":"DocmaWeb.Utils.DOM","$kind":"namespace","$docmaLink":"api/web/utils/#DocmaWeb.Utils.DOM","$members":[{"comment":"/**\n * Gets the offset coordinates of the given element, relative to document\n * body.\n * @name DocmaWeb.Utils.DOM.getOffset\n * @function\n * @static\n *\n * @param {HTMLElement} e - Target element.\n * @returns {Object|null} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1575,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the offset coordinates of the given element, relative to document\n body.","name":"getOffset","kind":"function","scope":"static","params":[{"type":{"names":["HTMLElement"]},"description":"Target element.","name":"e"}],"returns":[{"type":{"names":["Object","null"]},"description":"-"}],"memberof":"DocmaWeb.Utils.DOM","longname":"DocmaWeb.Utils.DOM.getOffset","$longname":"DocmaWeb.Utils.DOM.getOffset","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.DOM.getOffset"},{"comment":"/**\n * Scrolls the document to the given hash target.\n * @name DocmaWeb.Utils.DOM.scrollTo\n * @function\n * @static\n *\n * @param {String} [hash] - Bookmark target. If omitted, document is\n * scrolled to the top.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1599,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Scrolls the document to the given hash target.","name":"scrollTo","kind":"function","scope":"static","params":[{"type":{"names":["String"]},"optional":true,"description":"Bookmark target. If omitted, document is\n scrolled to the top.","name":"hash"}],"memberof":"DocmaWeb.Utils.DOM","longname":"DocmaWeb.Utils.DOM.scrollTo","$longname":"DocmaWeb.Utils.DOM.scrollTo","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.DOM.scrollTo"}]},{"comment":"/**\n * Gets code file information from the given symbol.\n * @name DocmaWeb.Utils.getCodeFileInfo\n * @function\n *\n * @param {Object} symbol - Target documentation symbol.\n * @returns {Object} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":946,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets code file information from the given symbol.","name":"getCodeFileInfo","kind":"function","params":[{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"}],"returns":[{"type":{"names":["Object"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getCodeFileInfo","scope":"static","$longname":"DocmaWeb.Utils.getCodeFileInfo","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getCodeFileInfo"},{"comment":"/**\n * Gets the code name of the given symbol.\n * @name DocmaWeb.Utils.getCodeName\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {String} - If no code name, falls back to long name.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":176,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the code name of the given symbol.","name":"getCodeName","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"- If no code name, falls back to long name."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getCodeName","scope":"static","$longname":"DocmaWeb.Utils.getCodeName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getCodeName"},{"comment":"/**\n * Gets HTML formatted, delimeted code tags.\n * @name DocmaWeb.Utils.getCodeTags\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Array} list - String list of values to be placed within code\n * tags.\n * @param {Object} [options] - Options.\n * @param {String} [options.delimeter=\",\"] - String delimeter.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1146,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets HTML formatted, delimeted code tags.","name":"getCodeTags","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Array"]},"description":"String list of values to be placed within code\n tags.","name":"list"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\",\"","description":"String delimeter.","name":"options.delimeter"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getCodeTags","scope":"static","$longname":"DocmaWeb.Utils.getCodeTags","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getCodeTags"},{"comment":"/**\n * Gets HTML formatted list of emitted events from the given list. Event\n * names items are wrapped with code tags. If multiple, formatted as an\n * HTML unordered list.\n * @name DocmaWeb.Utils.getEmittedEvents\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Array} list - List of emitted (fired) events.\n * @param {Object} [options] - Options.\n * @param {String} [options.delimeter=\", \"] - Events delimeter.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1243,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets HTML formatted list of emitted events from the given list. Event\n names items are wrapped with code tags. If multiple, formatted as an\n HTML unordered list.","name":"getEmittedEvents","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Array"]},"description":"List of emitted (fired) events.","name":"list"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\", \"","description":"Events delimeter.","name":"options.delimeter"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getEmittedEvents","scope":"static","$longname":"DocmaWeb.Utils.getEmittedEvents","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getEmittedEvents"},{"comment":"/**\n * Gets HTML formatted list of types from the given symbols list. Type\n * items are wrapped with code tags. If multiple, formatted as an HTML\n * unordered list.\n * @name DocmaWeb.Utils.getFormattedTypeList\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Array} list - List of symbols to be converted to formatted\n * string.\n * @param {Object} [options] - Format options.\n * @param {String} [options.delimeter=\"|\"] - Types delimeter.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n * @param {Boolean} [options.descriptions=true] - Whether to include descriptions.\n * @param {String} [options.descDelimeter=\" — \"] - Description delimiter.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1181,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets HTML formatted list of types from the given symbols list. Type\n items are wrapped with code tags. If multiple, formatted as an HTML\n unordered list.","name":"getFormattedTypeList","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Array"]},"description":"List of symbols to be converted to formatted\n string.","name":"list"},{"type":{"names":["Object"]},"optional":true,"description":"Format options.","name":"options"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"|\"","description":"Types delimeter.","name":"options.delimeter"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to include descriptions.","name":"options.descriptions"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\" — \"","description":"Description delimiter.","name":"options.descDelimeter"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getFormattedTypeList","scope":"static","$longname":"DocmaWeb.Utils.getFormattedTypeList","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getFormattedTypeList"},{"comment":"/**\n * Builds a string of keywords from the given symbol.\n * This is useful for filter/search features of a template.\n * @name DocmaWeb.Utils.getKeywords\n * @function\n *\n * @param {Object} symbol - Target documentation symbol.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":906,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Builds a string of keywords from the given symbol.\n This is useful for filter/search features of a template.","name":"getKeywords","kind":"function","params":[{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getKeywords","scope":"static","$longname":"DocmaWeb.Utils.getKeywords","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getKeywords"},{"comment":"/**\n * Gets the number of levels for the given symbol or name. e.g.\n * `mylib.prop` has 2 levels.\n * @name DocmaWeb.Utils.getLevels\n * @function\n *\n * @param {Object|String} symbol - Documented symbol object or long name.\n * @returns {Number} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":232,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the number of levels for the given symbol or name. e.g.\n `mylib.prop` has 2 levels.","name":"getLevels","kind":"function","params":[{"type":{"names":["Object","String"]},"description":"Documented symbol object or long name.","name":"symbol"}],"returns":[{"type":{"names":["Number"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getLevels","scope":"static","$longname":"DocmaWeb.Utils.getLevels","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getLevels"},{"comment":"/**\n * Gets the original long name of the given symbol.\n * JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n * alias. This returns the correct long name.\n * @name DocmaWeb.Utils.getLongName\n * @function\n * @alias getFullName\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":138,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the original long name of the given symbol.\n JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n alias. This returns the correct long name.","name":"getLongName","kind":"function","alias":"getFullName","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getLongName","$longname":"DocmaWeb.Utils.getLongName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getLongName"},{"comment":"/**\n * Gets the short name of the given symbol.\n * JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n * alias. This returns the correct short name.\n * @name DocmaWeb.Utils.getName\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":119,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the short name of the given symbol.\n JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n alias. This returns the correct short name.","name":"getName","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getName","scope":"static","$longname":"DocmaWeb.Utils.getName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getName"},{"comment":"/**\n * Gets the parent symbol object from the given symbol object or symbol's\n * name.\n * @name DocmaWeb.Utils.getParent\n * @function\n *\n * @param {Array|Object} docs - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object|String} symbol - Documented symbol object or long name.\n * @returns {String} - `null` if symbol has no parent.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":281,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the parent symbol object from the given symbol object or symbol's\n name.","name":"getParent","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docs"},{"type":{"names":["Object","String"]},"description":"Documented symbol object or long name.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"- `null` if symbol has no parent."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getParent","scope":"static","$longname":"DocmaWeb.Utils.getParent","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getParent"},{"comment":"/**\n * Gets the parent symbol name from the given symbol object or symbol's name\n * (notation). Note that, this will return the parent name even if the parent\n * symbol does not exist in the documentation. If there is no parent, returns\n * `\"\"` (empty string).\n * @name DocmaWeb.Utils.getParentName\n * @function\n *\n * @param {Object|String} symbol - Documented symbol object or long name.\n * @returns {Number} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":250,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the parent symbol name from the given symbol object or symbol's name\n (notation). Note that, this will return the parent name even if the parent\n symbol does not exist in the documentation. If there is no parent, returns\n `\"\"` (empty string).","name":"getParentName","kind":"function","params":[{"type":{"names":["Object","String"]},"description":"Documented symbol object or long name.","name":"symbol"}],"returns":[{"type":{"names":["Number"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getParentName","scope":"static","$longname":"DocmaWeb.Utils.getParentName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getParentName"},{"comment":"/**\n * Gets the return types of the symbol as a string (joined with pipes `|`).\n * @name DocmaWeb.Utils.getReturnTypes\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object} symbol - Target documentation symbol.\n * @param {Object} [options] - Options.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1107,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the return types of the symbol as a string (joined with pipes `|`).","name":"getReturnTypes","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getReturnTypes","scope":"static","$longname":"DocmaWeb.Utils.getReturnTypes","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getReturnTypes"},{"comment":"/**\n * Gets the first matching symbol by the given name.\n * @name DocmaWeb.Utils.getSymbolByName\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {String} name - Symbol name to be checked. Better, pass the\n * `longname` (or `$longname`). It will still find a short name but it'll\n * return the first occurence if there are multiple symbols with the same\n * short name. e.g. `create` is ambiguous but `Docma.create` is unique.\n *\n * @returns {Object} - Symbol object if found. Otherwise, returns `null`.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":188,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the first matching symbol by the given name.","name":"getSymbolByName","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["String"]},"description":"Symbol name to be checked. Better, pass the\n `longname` (or `$longname`). It will still find a short name but it'll\n return the first occurence if there are multiple symbols with the same\n short name. e.g. `create` is ambiguous but `Docma.create` is unique.","name":"name"}],"returns":[{"type":{"names":["Object"]},"description":"- Symbol object if found. Otherwise, returns `null`."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getSymbolByName","scope":"static","$longname":"DocmaWeb.Utils.getSymbolByName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getSymbolByName"},{"comment":"/**\n * Gets Docma route link for the given symbol or symbol name.\n * @name DocmaWeb.Utils.getSymbolLink\n * @function\n * @static\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object|String} symbolOrName - Either the symbol itself or the\n * name of the symbol.\n *\n * @returns {String} - Empty string if symbol is not found.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":962,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets Docma route link for the given symbol or symbol name.","name":"getSymbolLink","kind":"function","scope":"static","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Object","String"]},"description":"Either the symbol itself or the\n name of the symbol.","name":"symbolOrName"}],"returns":[{"type":{"names":["String"]},"description":"- Empty string if symbol is not found."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getSymbolLink","$longname":"DocmaWeb.Utils.getSymbolLink","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getSymbolLink"},{"comment":"/**\n * Gets the types of the symbol as a string (joined with pipes `|`).\n * @name DocmaWeb.Utils.getTypes\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object} symbol - Target documentation symbol.\n * @param {Object} [options] - Options.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n *\n * @example\n * var symbol = { \"type\": { \"names\": [\"Number\", \"String\"] } };\n * DocmaWeb.Utils.getTypes(docs, symbol); // \"Number|String\"\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1059,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the types of the symbol as a string (joined with pipes `|`).","name":"getTypes","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"examples":["var symbol = { \"type\": { \"names\": [\"Number\", \"String\"] } };\n DocmaWeb.Utils.getTypes(docs, symbol); // \"Number|String\""],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getTypes","scope":"static","$longname":"DocmaWeb.Utils.getTypes","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getTypes"},{"comment":"/**\n * Checks whether the given symbol has description.\n * @name DocmaWeb.Utils.hasDescription\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":711,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has description.","name":"hasDescription","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.hasDescription","scope":"static","$longname":"DocmaWeb.Utils.hasDescription","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.hasDescription"},{"comment":"/**\n * Checks whether the given symbol is a callback definition.\n * @name DocmaWeb.Utils.isCallback\n * @function\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":565,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a callback definition.","name":"isCallback","kind":"function","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isCallback","$longname":"DocmaWeb.Utils.isCallback","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isCallback"},{"comment":"/**\n * Checks whether the given symbol is a class.\n * @name DocmaWeb.Utils.isClass\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":365,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a class.","name":"isClass","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isClass","scope":"static","$longname":"DocmaWeb.Utils.isClass","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isClass"},{"comment":"/**\n * Checks whether the given symbol is marked as a constant.\n * @name DocmaWeb.Utils.isConstant\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":382,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is marked as a constant.","name":"isConstant","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isConstant","scope":"static","$longname":"DocmaWeb.Utils.isConstant","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isConstant"},{"comment":"/**\n * Checks whether the given symbol is a constructor.\n * @name DocmaWeb.Utils.isConstructor\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":394,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a constructor.","name":"isConstructor","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isConstructor","scope":"static","$longname":"DocmaWeb.Utils.isConstructor","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isConstructor"},{"comment":"/**\n * Checks whether the given symbol is deprecated.\n * @name DocmaWeb.Utils.isDeprecated\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":304,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is deprecated.","name":"isDeprecated","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isDeprecated","scope":"static","$longname":"DocmaWeb.Utils.isDeprecated","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isDeprecated"},{"comment":"/**\n * Checks whether the given symbol is an enumeration.\n * @name DocmaWeb.Utils.isEnum\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":584,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an enumeration.","name":"isEnum","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isEnum","scope":"static","$longname":"DocmaWeb.Utils.isEnum","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isEnum"},{"comment":"/**\n * Checks whether the given symbol is an event.\n * @name DocmaWeb.Utils.isEvent\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":596,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an event.","name":"isEvent","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isEvent","scope":"static","$longname":"DocmaWeb.Utils.isEvent","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isEvent"},{"comment":"/**\n * Checks whether the given symbol is defined outside of the current package.\n * @name DocmaWeb.Utils.isExternal\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":608,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is defined outside of the current package.","name":"isExternal","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isExternal","scope":"static","$longname":"DocmaWeb.Utils.isExternal","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isExternal"},{"comment":"/**\n * Checks whether the given symbol is a generator function.\n * @name DocmaWeb.Utils.isGenerator\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":620,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a generator function.","name":"isGenerator","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isGenerator","scope":"static","$longname":"DocmaWeb.Utils.isGenerator","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isGenerator"},{"comment":"/**\n * Checks whether the given symbol has global scope.\n * @name DocmaWeb.Utils.isGlobal\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":316,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has global scope.","name":"isGlobal","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isGlobal","scope":"static","$longname":"DocmaWeb.Utils.isGlobal","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isGlobal"},{"comment":"/**\n * Checks whether the given symbol has an inner scope.\n * @name DocmaWeb.Utils.isInner\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":429,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has an inner scope.","name":"isInner","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInner","scope":"static","$longname":"DocmaWeb.Utils.isInner","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInner"},{"comment":"/**\n * Checks whether the given symbol is an instance member.\n * @name DocmaWeb.Utils.isInstanceMember\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":441,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an instance member.","name":"isInstanceMember","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInstanceMember","scope":"static","$longname":"DocmaWeb.Utils.isInstanceMember","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInstanceMember"},{"comment":"/**\n * Checks whether the given symbol is an instance method.\n * @name DocmaWeb.Utils.isInstanceMethod\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":486,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an instance method.","name":"isInstanceMethod","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInstanceMethod","scope":"static","$longname":"DocmaWeb.Utils.isInstanceMethod","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInstanceMethod"},{"comment":"/**\n * Checks whether the given symbol is an instance property.\n * @name DocmaWeb.Utils.isInstanceProperty\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":522,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an instance property.","name":"isInstanceProperty","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInstanceProperty","scope":"static","$longname":"DocmaWeb.Utils.isInstanceProperty","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInstanceProperty"},{"comment":"/**\n * Checks whether the given symbol is marked as an interface that other symbols\n * can implement.\n * @name DocmaWeb.Utils.isInterface\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":453,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is marked as an interface that other symbols\n can implement.","name":"isInterface","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInterface","scope":"static","$longname":"DocmaWeb.Utils.isInterface","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInterface"},{"comment":"/**\n * Checks whether the given symbol is a method (function).\n * @name DocmaWeb.Utils.isMethod\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":466,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a method (function).","name":"isMethod","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isMethod","scope":"static","$longname":"DocmaWeb.Utils.isMethod","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isMethod"},{"comment":"/**\n * Checks whether the given symbol is marked as a mixin (is intended to be\n * added to other objects).\n * @name DocmaWeb.Utils.isMixin\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":352,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is marked as a mixin (is intended to be\n added to other objects).","name":"isMixin","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isMixin","scope":"static","$longname":"DocmaWeb.Utils.isMixin","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isMixin"},{"comment":"/**\n * Checks whether the given symbol is a module.\n * @name DocmaWeb.Utils.isModule\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":340,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a module.","name":"isModule","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isModule","scope":"static","$longname":"DocmaWeb.Utils.isModule","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isModule"},{"comment":"/**\n * Checks whether the given symbol is a namespace.\n * @name DocmaWeb.Utils.isNamespace\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":328,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a namespace.","name":"isNamespace","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isNamespace","scope":"static","$longname":"DocmaWeb.Utils.isNamespace","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isNamespace"},{"comment":"/**\n * Checks whether the given symbol has `package` private access; indicating\n * that the symbol is available only to code in the same directory as the\n * source file for this symbol.\n * @name DocmaWeb.Utils.isPackagePrivate\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":668,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `package` private access; indicating\n that the symbol is available only to code in the same directory as the\n source file for this symbol.","name":"isPackagePrivate","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isPackagePrivate","scope":"static","$longname":"DocmaWeb.Utils.isPackagePrivate","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isPackagePrivate"},{"comment":"/**\n * Checks whether the given symbol has `private` access.\n * @name DocmaWeb.Utils.isPrivate\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":656,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `private` access.","name":"isPrivate","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isPrivate","scope":"static","$longname":"DocmaWeb.Utils.isPrivate","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isPrivate"},{"comment":"/**\n * Checks whether the given symbol is a property (and not a method/function).\n * @name DocmaWeb.Utils.isProperty\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":510,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a property (and not a method/function).","name":"isProperty","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isProperty","scope":"static","$longname":"DocmaWeb.Utils.isProperty","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isProperty"},{"comment":"/**\n * Checks whether the given symbol has `protected` access.\n * @name DocmaWeb.Utils.isProtected\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":682,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `protected` access.","name":"isProtected","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isProtected","scope":"static","$longname":"DocmaWeb.Utils.isProtected","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isProtected"},{"comment":"/**\n * Checks whether the given symbol has `public` access.\n * @name DocmaWeb.Utils.isPublic\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":644,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `public` access.","name":"isPublic","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isPublic","scope":"static","$longname":"DocmaWeb.Utils.isPublic","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isPublic"},{"comment":"/**\n * Checks whether the given symbol is read-only.\n * @name DocmaWeb.Utils.isReadOnly\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":632,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is read-only.","name":"isReadOnly","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isReadOnly","scope":"static","$longname":"DocmaWeb.Utils.isReadOnly","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isReadOnly"},{"comment":"/**\n * Checks whether the given symbol is a static member.\n * @name DocmaWeb.Utils.isStaticMember\n * @function\n * @alias isStatic\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":410,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a static member.","name":"isStaticMember","kind":"function","alias":"isStatic","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isStaticMember","$longname":"DocmaWeb.Utils.isStaticMember","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isStaticMember"},{"comment":"/**\n * Checks whether the given symbol is a static method.\n * @name DocmaWeb.Utils.isStaticMethod\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":498,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a static method.","name":"isStaticMethod","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isStaticMethod","scope":"static","$longname":"DocmaWeb.Utils.isStaticMethod","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isStaticMethod"},{"comment":"/**\n * Checks whether the given symbol is a static property.\n * @name DocmaWeb.Utils.isStaticProperty\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":534,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a static property.","name":"isStaticProperty","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isStaticProperty","scope":"static","$longname":"DocmaWeb.Utils.isStaticProperty","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isStaticProperty"},{"comment":"/**\n * Checks whether the given symbol is a custom type definition.\n * @name DocmaWeb.Utils.isTypeDef\n * @function\n * @alias isCustomType\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":546,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a custom type definition.","name":"isTypeDef","kind":"function","alias":"isCustomType","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isTypeDef","$longname":"DocmaWeb.Utils.isTypeDef","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isTypeDef"},{"comment":"/**\n * Checks whether the given symbol is undocumented.\n * This checks if the symbol has any comments.\n * @name DocmaWeb.Utils.isUndocumented\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":694,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Checks whether the given symbol is undocumented.\n This checks if the symbol has any comments.","name":"isUndocumented","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isUndocumented","scope":"static","$longname":"DocmaWeb.Utils.isUndocumented","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isUndocumented"},{"comment":"/**\n * Normalizes the number of spaces/tabs to multiples of 2 spaces, in the\n * beginning of each line. Useful for fixing mixed indets of a description\n * or example.\n * @name DocmaWeb.Utils.normalizeTabs\n * @function\n *\n * @param {String} string - String to process.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":864,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Normalizes the number of spaces/tabs to multiples of 2 spaces, in the\n beginning of each line. Useful for fixing mixed indets of a description\n or example.","name":"normalizeTabs","kind":"function","params":[{"type":{"names":["String"]},"description":"String to process.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.normalizeTabs","scope":"static","$longname":"DocmaWeb.Utils.normalizeTabs","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.normalizeTabs"},{"comment":"/**\n * Gets the value of the target property by the given dot\n * {@link https://github.com/onury/notation|notation}.\n * @name DocmaWeb.Utils.notate\n * @function\n * @static\n *\n * @param {Object} obj - Source object.\n * @param {String} notation - Path of the property in dot-notation.\n *\n * @returns {*} - The value of the notation. If the given notation does\n * not exist, safely returns `undefined`.\n *\n * @example\n * var symbol = { code: { meta: { type: \"MethodDefinition\" } } };\n * DocmaWeb.Utils.notate(symbol, \"code.meta.type\"); // returns \"MethodDefinition\"\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":88,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the value of the target property by the given dot\n {@link https://github.com/onury/notation|notation}.","name":"notate","kind":"function","scope":"static","params":[{"type":{"names":["Object"]},"description":"Source object.","name":"obj"},{"type":{"names":["String"]},"description":"Path of the property in dot-notation.","name":"notation"}],"returns":[{"type":{"names":["*"]},"description":"- The value of the notation. If the given notation does\n not exist, safely returns `undefined`."}],"examples":["var symbol = { code: { meta: { type: \"MethodDefinition\" } } };\n DocmaWeb.Utils.notate(symbol, \"code.meta.type\"); // returns \"MethodDefinition\""],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.notate","$longname":"DocmaWeb.Utils.notate","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.notate"},{"comment":"/**\n * Parses the given string into proper HTML. Removes leading whitespace,\n * converts new lines to paragraphs, ticks to code tags and JSDoc links to\n * anchors.\n * @name DocmaWeb.Utils.parse\n * @function\n *\n * @param {String} string - String to be parsed.\n * @param {Object} [options] - Parse options.\n * @param {Object} [options.keepIfSingle=false]\n * If enabled, single lines will not be converted to paragraphs.\n * @param {String} [options.target]\n * Href target for links. e.g. `\"_blank\"`\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":840,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Parses the given string into proper HTML. Removes leading whitespace,\n converts new lines to paragraphs, ticks to code tags and JSDoc links to\n anchors.","name":"parse","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"},{"type":{"names":["Object"]},"optional":true,"description":"Parse options.","name":"options"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":false,"description":"If enabled, single lines will not be converted to paragraphs.","name":"options.keepIfSingle"},{"type":{"names":["String"]},"optional":true,"description":"Href target for links. e.g. `\"_blank\"`","name":"options.target"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parse","scope":"static","$longname":"DocmaWeb.Utils.parse","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parse"},{"comment":"/**\n * Converts JSDoc `@link` directives to HTML anchor tags.\n * @name DocmaWeb.Utils.parseLinks\n * @function\n *\n * @param {String} string - String to be parsed.\n * @param {Object} [options] - Parse options.\n * @param {String} [options.target] - Href target. e.g. `\"_blank\"`\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":800,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Converts JSDoc `@link` directives to HTML anchor tags.","name":"parseLinks","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"},{"type":{"names":["Object"]},"optional":true,"description":"Parse options.","name":"options"},{"type":{"names":["String"]},"optional":true,"description":"Href target. e.g. `\"_blank\"`","name":"options.target"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parseLinks","scope":"static","$longname":"DocmaWeb.Utils.parseLinks","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parseLinks"},{"comment":"/**\n * Converts new lines to HTML paragraphs.\n * @name DocmaWeb.Utils.parseNewLines\n * @function\n *\n * @param {String} string - String to be parsed.\n * @param {Object} [options] - Parse options.\n * @param {Boolean} [options.keepIfSingle=false]\n * If `true`, lines will not be converted to paragraphs.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":774,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Converts new lines to HTML paragraphs.","name":"parseNewLines","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"},{"type":{"names":["Object"]},"optional":true,"description":"Parse options.","name":"options"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, lines will not be converted to paragraphs.","name":"options.keepIfSingle"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parseNewLines","scope":"static","$longname":"DocmaWeb.Utils.parseNewLines","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parseNewLines"},{"comment":"/**\n * Converts back-ticks to HTML code tags.\n * @name DocmaWeb.Utils.parseTicks\n * @function\n *\n * @param {String} string\n * String to be parsed.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":749,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Converts back-ticks to HTML code tags.","name":"parseTicks","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parseTicks","scope":"static","$longname":"DocmaWeb.Utils.parseTicks","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parseTicks"},{"comment":"/**\n * Removes leading spaces and dashes. Useful when displaying symbol\n * descriptions.\n * @name DocmaWeb.Utils.trimLeft\n * @function\n *\n * @param {String} string - String to be trimmed.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":723,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Removes leading spaces and dashes. Useful when displaying symbol\n descriptions.","name":"trimLeft","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be trimmed.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.trimLeft","scope":"static","$longname":"DocmaWeb.Utils.trimLeft","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.trimLeft"},{"comment":"/**\n * Removes leading and trailing new lines.\n * @name DocmaWeb.Utils.trimNewLines\n * @function\n *\n * @param {String} string - String to be trimmed.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":737,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Removes leading and trailing new lines.","name":"trimNewLines","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be trimmed.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.trimNewLines","scope":"static","$longname":"DocmaWeb.Utils.trimNewLines","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.trimNewLines"},{"comment":"/**\n * Gets the type of the given object.\n * @name DocmaWeb.Utils.type\n * @function\n * @static\n *\n * @param {*} obj - Object to be inspected.\n * @returns {String} - Lower-case name of the type.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":72,"columnno":0,"path":"/home/jacekjanpietal/projects/docma/lib/web","code":{}},"description":"Gets the type of the given object.","name":"type","kind":"function","scope":"static","params":[{"type":{"names":["*"]},"description":"Object to be inspected.","name":"obj"}],"returns":[{"type":{"names":["String"]},"description":"- Lower-case name of the type."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.type","$longname":"DocmaWeb.Utils.type","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.type"}]}]}],"symbols":["DocmaWeb","DocmaWeb.Utils","DocmaWeb.Utils.DOM","DocmaWeb.Utils.DOM.getOffset","DocmaWeb.Utils.DOM.scrollTo","DocmaWeb.Utils.getCodeFileInfo","DocmaWeb.Utils.getCodeName","DocmaWeb.Utils.getCodeTags","DocmaWeb.Utils.getEmittedEvents","DocmaWeb.Utils.getFormattedTypeList","DocmaWeb.Utils.getKeywords","DocmaWeb.Utils.getLevels","DocmaWeb.Utils.getLongName","DocmaWeb.Utils.getName","DocmaWeb.Utils.getParent","DocmaWeb.Utils.getParentName","DocmaWeb.Utils.getReturnTypes","DocmaWeb.Utils.getSymbolByName","DocmaWeb.Utils.getSymbolLink","DocmaWeb.Utils.getTypes","DocmaWeb.Utils.hasDescription","DocmaWeb.Utils.isCallback","DocmaWeb.Utils.isClass","DocmaWeb.Utils.isConstant","DocmaWeb.Utils.isConstructor","DocmaWeb.Utils.isDeprecated","DocmaWeb.Utils.isEnum","DocmaWeb.Utils.isEvent","DocmaWeb.Utils.isExternal","DocmaWeb.Utils.isGenerator","DocmaWeb.Utils.isGlobal","DocmaWeb.Utils.isInner","DocmaWeb.Utils.isInstanceMember","DocmaWeb.Utils.isInstanceMethod","DocmaWeb.Utils.isInstanceProperty","DocmaWeb.Utils.isInterface","DocmaWeb.Utils.isMethod","DocmaWeb.Utils.isMixin","DocmaWeb.Utils.isModule","DocmaWeb.Utils.isNamespace","DocmaWeb.Utils.isPackagePrivate","DocmaWeb.Utils.isPrivate","DocmaWeb.Utils.isProperty","DocmaWeb.Utils.isProtected","DocmaWeb.Utils.isPublic","DocmaWeb.Utils.isReadOnly","DocmaWeb.Utils.isStaticMember","DocmaWeb.Utils.isStaticMethod","DocmaWeb.Utils.isStaticProperty","DocmaWeb.Utils.isTypeDef","DocmaWeb.Utils.isUndocumented","DocmaWeb.Utils.normalizeTabs","DocmaWeb.Utils.notate","DocmaWeb.Utils.parse","DocmaWeb.Utils.parseLinks","DocmaWeb.Utils.parseNewLines","DocmaWeb.Utils.parseTicks","DocmaWeb.Utils.trimLeft","DocmaWeb.Utils.trimNewLines","DocmaWeb.Utils.type"]}},"app":{"title":"Docma Documentation","meta":null,"base":"./","entrance":"content:home","routing":{"method":"path","caseSensitive":true},"server":"github","favicon":"./favicon.ico"},"template":{"name":"docma-template-zebra","description":"Zebra - Default template for Docma. https://github.com/onury/docma","version":"2.3.1","supportedDocmaVersion":">=2.0.0","author":"Onur Yıldırım","license":"MIT","mainHTML":"index.html","options":{"title":{"label":"Docma","href":"."},"logo":{"dark":"img/docma-logo.png","light":"img/docma-logo.png"},"sidebar":{"enabled":true,"outline":"tree","collapsed":false,"toolbar":true,"itemsFolded":false,"itemsOverflow":"crop","badges":true,"search":true,"animations":true},"symbols":{"autoLink":true,"params":"list","enums":"list","props":"list","meta":false},"contentView":{"bookmarks":"h1,h2,h3","faLibs":"all","faVersion":"5.5.0"},"navbar":{"enabled":true,"fixed":true,"dark":false,"animations":true,"menu":[{"iconClass":"fas fa-book","label":"Building Docs","items":[{"label":"Guide","href":"."},{"separator":true},{"label":"Docma (Builder) API","href":"api"},{"label":"Build Configuration","href":"api/#Docma~BuildConfiguration"}],"chevron":true},{"iconClass":"fas fa-puzzle-piece","label":"Templates","items":[{"label":"Default Template - Zebra","href":"templates/zebra"},{"separator":true},{"label":"Docma Template API","href":"api/#Docma.Template"},{"label":"Docma Web API","href":"api/web"}],"chevron":true},{"iconClass":"fas fa-cloud-download-alt","label":"Download","items":[{"label":"npm i @jacekpietal/docma -D","href":"https://www.npmjs.com/package/@jacekpietal/docma","target":"_blank"},{"label":"Docma Releases","href":"https://github.com/Prozi/docma/releases","target":"_blank"},{"separator":true},{"label":"Change Log","href":"changelog"}],"chevron":true},{"iconClass":"fab fa-lg fa-github","label":"","href":"https://github.com/Prozi/docma","target":"_blank"}]}}},"partials":{"api":"docma-api","content":"docma-content","notFound":"docma-404"},"elementID":"docma-main","contentElementID":"docma-content","defaultApiName":"_def_","logsEnabled":true}));
+var docma = Object.freeze(new DocmaWeb({"version":"3.3.3","routes":[{"id":"api:","type":"api","name":"_def_","path":"api/","contentPath":null,"sourceType":"js"},{"id":"api:web","type":"api","name":"web","path":"api/web/","contentPath":null,"sourceType":"js"},{"id":"api:web/utils","type":"api","name":"web/utils","path":"api/web/utils/","contentPath":null,"sourceType":"js"},{"id":"content:changelog","type":"content","name":"changelog","path":"changelog/","contentPath":"content/changelog.html","sourceType":"md"},{"id":"content:readme","type":"content","name":"readme","path":"readme/","contentPath":"content/readme.html","sourceType":"md"},{"id":"content:license","type":"content","name":"license","path":"license/","contentPath":"content/license.html","sourceType":"md"},{"id":"content:home","type":"content","name":"home","path":"home/","contentPath":"content/home.html","sourceType":"md"},{"id":"content:templates/zebra","type":"content","name":"templates/zebra","path":"templates/zebra/","contentPath":"content/templates/zebra.html","sourceType":"md"}],"apis":{"_def_":{"documentation":[{"comment":"/**\n * Docma (builder) class for generating HTML documentation from the given\n * Javascript and/or markdown source files. This is the default object exported\n * from the `docma` Node module.\n *\n * This documentation you're reading is built with Docma.
\n * @class\n *\n * @example\n * const Docma = require('docma');\n */","meta":{"range":[1333,42348],"filename":"Docma.js","lineno":48,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100000108","name":"Docma","type":"ClassDeclaration","paramnames":[]}},"name":"Docma","longname":"Docma","kind":"class","classdesc":"Docma (builder) class for generating HTML documentation from the given\n Javascript and/or markdown source files. This is the default object exported\n from the `docma` Node module.\n\n This documentation you're reading is built with Docma.
","examples":["const Docma = require('docma');"],"scope":"global","description":"Initializes a new instance of `Docma`.","$longname":"Docma","$kind":"class","$docmaLink":"api/#Docma","$constructor":{"comment":"/**\n * Initializes a new instance of `Docma`.\n * @example\n * const docma = new Docma();\n */","meta":{"range":[1466,1482],"filename":"Docma.js","lineno":54,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100000111","name":"Docma","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"Initializes a new instance of `Docma`.","examples":["const docma = new Docma();"],"name":"Docma","longname":"Docma","kind":"class","scope":"global","params":[],"undocumented":true,"$longname":"Docma","$kind":"constructor","$docmaLink":"api/#Docma"},"$members":[{"comment":"/**\n * Docma build configuration object that defines parse options for the given\n * source files; and templating options for the Single Page Application to be\n * generated.\n *\n * This is very configurable but, you're only required to define very few\n * options such as the source files (`src`) and the destination directory\n * (`dest`) for a simple build.\n *\n * See the example at the bottom or for a real example; check out Docma's own\n * build configuration file, that generates this documentation you're reading\n * {@link https://github.com/Prozi/docma/blob/master/docma.json|here}.
\n *\n * @typedef Docma~BuildConfiguration\n * @type Object\n *\n * @param {String|Array|Object} src One or more source file/directory paths to\n * be processed. This also accepts\n * {@link https://github.com/isaacs/node-glob|Glob} strings or array of\n * globs. e.g. `./src/**/*.js` will produce an array of\n * all `.js` files under `./src` directory and sub-directories.\n *\n * JavaScript files will be parsed with JSDoc and files with `.md`, `.htm`\n * and `.html` extensions will be automatically parsed to proper formats.\n * But if you need; you can force a specific parser on defined files.\n * e.g. `./LICENSE:md` will be force-parsed to markdown.\n *\n * See examples at the bottom for a better understanding.\n * @param {Object} [assets] Non-source, static asset files/directories to be\n * copied over to build directory; so you can use/link to files such as\n * images, ZIPs, PDFs, etc... Keys of this object define the target\n * directory, relative to the build destination directory. Value of each\n * key can either be a single file path string or an array. This also\n * accepts {@link https://github.com/isaacs/node-glob|Glob} strings or\n * array of globs. e.g. `{ \"/\": [\"./*.png\"] }` will copy all PNG\n * files of the current relative directory to the root of destination\n * directory. CAUTION: Each copy operation will overwrite the\n * file if it already exists.\n * @param {String} dest Destination output directory path. CAUTION:\n * Files in this directory will be overwritten. If `clean` option is\n * enabled, all contents will be removed. Make sure you set this to\n * a correct path.\n * @param {Boolean} [clean=false] Whether the destination directory should be\n * emptied before the build.\n * @param {Boolean|Number} [debug=false] Specifies debug settings for build\n * operation and generated SPA. This takes a bitwise numeric value so\n * you can combine flags to your liking. If a `Boolean` value set,\n * `false` means `Docma.Debug.DISABLED` and `true` means\n * `Docma.Debug.ALL` which enables all debugging options. See\n * {@link #Docma.Debug|`Debug` flags enumeration} for all possible\n * values.\n * @param {Object} [jsdoc] - JSDoc parse options.\n * @param {String} [jsdoc.encoding=\"utf8\"] Encoding to be used when reading JS\n * source files.\n * @param {Boolean} [jsdoc.recurse=false] Specifies whether to recurse into\n * sub-directories when scanning for source files.\n * @param {Boolean} [jsdoc.pedantic=false] Specifies whether to treat errors as\n * fatal errors, and treat warnings as errors.\n * @param {String|Array} [jsdoc.access] Specifies which symbols to be processed\n * with the given access property. Possible values: `\"private\"`,\n * `\"protected\"`, `\"public\"` or `\"all\"` (for all access levels). By\n * default, all except private symbols are processed. Note that, if\n * access is not set for a documented symbol, it will still be included,\n * regardless of this option.\n * @param {Boolean} [jsdoc.private=false] -\n * @param {String} [jsdoc.package] The path to the `package.json` file that\n * contains the project name, version, and other details. If set to\n * `true` instead of a path string, the first `package.json` file found\n * in the source paths.\n * @param {Boolean} [jsdoc.module=true] Specifies whether to include\n * `module.exports` symbols.\n * @param {Boolean} [jsdoc.undocumented=false] Specifies whether to include\n * undocumented symbols.\n * @param {Boolean} [jsdoc.undescribed=false] Specifies whether to include\n * symbols without a description.\n * @param {Boolean} [jsdoc.ignored=false] Specifies whether to include symbols\n * marked with `ignore` tag.\n * @param {String} [jsdoc.relativePath] When set, all `symbol.meta.path` values\n * will be relative to this path.\n * @param {Function} [jsdoc.predicate] This is used to filter the parsed\n * documentation output array. If a `Function` is passed; it's invoked\n * for each included `symbol`. e.g. `function (symbol) { return symbol;\n * }` Returning a falsy value will remove the symbol from the output.\n * Returning `true` will keep the original symbol. To keep the symbol\n * and alter its contents, simply return an altered symbol object.\n * @param {Boolean} [jsdoc.hierarchy=false] Specifies whether to arrange\n * symbols by their hierarchy. This will find and move symbols that have\n * a `memberof` property to a `$members` property of their corresponding\n * owners. Also the constructor symbol will be moved to a `$constructor`\n * property of the `ClassDeclaration` symbol; if any.\n * @param {Boolean|String} [jsdoc.sort=\"alphabetic\"] Specifies whether to sort\n * the documentation symbols. For alphabetic sort, set to `true` or\n * `\"alphabetic\"`. To group-sort set to `\"grouped\"`. (Group sorting\n * is done in the following order: by memberof, by scope, by access\n * type, by kind, alphabetic.) To sort by only `\"scope\"` or\n * `\"access\"` or `\"kind\"`, set to corresponding string. (Sorting by\n * kind is done in the following order: constant, package/module,\n * namespace, class, constructor, method, property, enum, typedef,\n * event, interface, mixin, external, other members.) Set to `false`\n * to disable. Note that this sorts the documentation symbols data,\n * how it's displayed might be altered by the Docma template you're\n * using.\n * @param {Boolean} [jsdoc.allowUnknownTags=true] Specifies whether to allow\n * unrecognized tags. If set to `false` parsing will fail on unknown\n * tags.\n * @param {Array} [jsdoc.dictionaries=[\"jsdoc\", \"closure\"]] Indicates the\n * dictionaries to be used. By default, both standard JSDoc tags and\n * Closure Compiler tags are enabled.\n * @param {String} [jsdoc.includePattern=\".+\\\\.js(doc|x)?$\"] String pattern for\n * defining sources to be included. By default, only files ending in\n * `\".js\"`, \"`.jsdoc\"`, and `\".jsx\"` will be processed.\n * @param {String} [jsdoc.excludePattern=\"(^|\\\\/|\\\\\\\\)_\"] String pattern for\n * defining sources to be ignored. By default, any file starting with an\n * underscore or in a directory starting with an underscore will be\n * ignored.\n * @param {Array} [jsdoc.plugins=[]] Defines the JSDoc plugins to be used. See\n * {@link https://usejsdoc.org/about-plugins.html|this guide} on JSDoc\n * plugins.\n * @param {Object} [markdown] - Markdown parse options.\n * @param {Boolean} [markdown.gfm=true] Whether to enable\n * {@link https://help.github.com/categories/writing-on-github|GitHub flavored markdown}.\n * @param {Boolean} [markdown.tables=true] Whether to enable enable GFM\n * {@link https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables|tables}.\n * This option requires the `gfm` option to be `true`.\n * @param {Boolean} [markdown.breaks=false] Whether to enable enable GFM\n * {@link https://help.github.com/articles/basic-writing-and-formatting-syntax/#paragraphs-and-line-breaks|line breaks}.\n * This option requires the `gfm` option to be `true`.\n * @param {Boolean} [markdown.pedantic=false] Whether to conform with obscure\n * parts of `markdown.pl` as much as possible. Don't fix any of the\n * original markdown bugs or poor behavior.\n * @param {Boolean} [markdown.sanitize=false] Whether to use smarter list\n * behavior than the original markdown. May eventually be default with\n * the old behavior moved into `pedantic`.\n * @param {Boolean} [markdown.smartypants=false] Whether to use \"smart\"\n * typographic punctuation for things like quotes and dashes.\n * @param {Boolean} [markdown.xhtml=false] Self-close the tags for void\n * elements (`
`, `![]()
`, etc.) with a `\"/\"` as required by XHTML.\n * @param {Boolean} [markdown.tasks=true] Whether to parse GitHub style task\n * markdown (e.g. `- [x] task`) into checkbox elements.\n * @param {Boolean} [markdown.emoji=true] If set to `true`, emoji shortcuts\n * (e.g. `:smiley:`) are parsed into `<img />` elements\n * with {@link https://twitter.github.io/twemoji|twemoji} SVG URLs.\n * @param {Object} [app] Configuration for the generated SPA (Single Page\n * Application).\n * @param {String} [app.title=\"\"] Title of the main HTML document of the\n * generated web app. (Sets the value of the `<title>` element.)\n * @param {Array|Object} [app.meta] One or more meta elements to be set for the\n * main HTML document of the generated web app. Set arbitrary object(s)\n * for each meta element to be added. e.g. `[{ charset: \"utf-8\"}, {\n * name: \"robots\", \"content\": \"index, follow\" }]`.\n * @param {String} [app.base=\"/\"] Sets the base path of the generated web app.\n * For example if the app will operate within `/doc/*` set the base path\n * to `\"/doc\"`.\n * @param {String} [app.favicon] Local path to a `favicon.ico` file to be used\n * with the web app.\n * @param {String} [app.entrance=\"api\"] Defines the home content to be\n * displayed for the application root (when you enter the base path i.e.\n * `\"/\"`). Pass the type and name of the route in `{type}:{name}`\n * format. There are 2 types of routes: `api` for JS source\n * documentation and `content` for other HTML content such as parsed\n * markdown files. For example, if you have a grouped JS files\n * documented with a name `mylib`; to define this as the entrance of the\n * app, set this to `\"api:mylib\"`. If you have `\"README.md\"` in your\n * source files; to define this as the entrance, set this to\n * `\"content:readme\"`.\n * @param {String|Object} [app.routing] Either a `String` defining the route\n * method or an `Object` defining both the method and whether the routes\n * should be case-sensitive.\n * @param {String} [app.routing.method=\"query\"]\n * Indicates the routing method for the generated SPA (Single\n * Page Application).\n * See {@link #Docma.RoutingMethod|`RoutingMethod` enumeration}.\n * @param {Boolean} [app.routing.caseSensitive=true]\n * Indicates whether the routes should be case-sensitive.\n * Note that if this is set to `false`, same route names will\n * overwrite the previous, even if they have different case.\n * @param {String} [app.server=\"static\"] Server or host type for the SPA. This\n * information helps Docma determine how to configure the generated SPA,\n * especially if `routing.method` is set to `\"path\"`. See\n * {@link #Docma.ServerType|`ServerType` enumeration} for details.\n * @param {Object} [template] - SPA template configuration.\n * @param {String} [template.path=\"default\"] Either the path of a custom Docma\n * template or the name of a built-in template. Omit to use the default\n * built-in template.\n * @param {Object} [template.options] SPA template options. This is defined by\n * the template itself. Refer to the template's documentation for\n * options to be set at build-time. See\n * {@link templates/zebra/#template-options|Default Template options}.\n *\n * @example\n * const buildConfig = {\n * src: [\n * // using an object to define (group) names for JS files.\n * {\n * // grouping JS files under the name \"my-lib\".\n * // This name also defines the api route name: e.g. ?api=my-lib or api/my-lib/\n * 'my-lib': [\n * './src/** /*.js', // recurse all JS files under /src\n * './lib/some-other.js',\n * '!./lib/ignored.js' // notice the bang! prefix to exclude this file\n * ],\n * // naming another api route\n * 'other-lib': './other/*.js', // ?api=other-lib\n * },\n *\n * // ungrouped js files will be merged under default route\n * './src/main.js', // ?api or ?api=_def_\n * './src/main.utils.js', // merged into same ?api or ?api=_def_\n *\n * // including markdown (\"content\") files\n * './CHANGELOG.md', // this will have 'changelog' as route name.\n * // i.e. ?content=changelog\n * // forcing specific parser on files:\n * './LICENSE:md', // LICENSE file with no-extension is forced\n * // to markdown via :md suffix.\n * // route will be ?content=license or license/\n * // using an object to rename the route for the given markdown files\n * {\n * guide: './README.md' // this will have 'guide' as content route name\n * } // i.e. ?content=guide or guide/\n * ],\n * dest: './output/docs', // output directory for the generated docs\n * app: {\n * title: 'My Documentation', // title of the app\n * routing: 'query', // routing method \"query\" or \"path\"\n * entrance: 'content:guide', // initial route to load on entrance\n * base: '/' // base path of the SPA\n * },\n *\n * // template-specific configuration.\n * // for Zebra template, see https://onury.io/docma/templates/zebra\n * template: {\n * path: 'zebra',\n * options: {\n * title: {\n * label: 'My Docs',\n * href: '/docs/?'\n * },\n * navbar: true,\n * sidebar: {\n * enabled: true,\n * outline: 'tree'\n * }\n * }\n * }\n * };\n * // See Docma's own configuration @\n * // https://github.com/Prozi/docma/blob/master/docma.json\n */","meta":{"filename":"Docma.js","lineno":1235,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Docma build configuration object that defines parse options for the given\n source files; and templating options for the Single Page Application to be\n generated.\n\n This is very configurable but, you're only required to define very few\n options such as the source files (`src`) and the destination directory\n (`dest`) for a simple build.\n\n See the example at the bottom or for a real example; check out Docma's own\n build configuration file, that generates this documentation you're reading\n {@link https://github.com/Prozi/docma/blob/master/docma.json|here}.
","kind":"typedef","name":"BuildConfiguration","type":{"names":["Object"]},"params":[{"type":{"names":["String","Array","Object"]},"description":"One or more source file/directory paths to\n be processed. This also accepts\n {@link https://github.com/isaacs/node-glob|Glob} strings or array of\n globs. e.g. `./src/**/*.js` will produce an array of\n all `.js` files under `./src` directory and sub-directories.\n\n JavaScript files will be parsed with JSDoc and files with `.md`, `.htm`\n and `.html` extensions will be automatically parsed to proper formats.\n But if you need; you can force a specific parser on defined files.\n e.g. `./LICENSE:md` will be force-parsed to markdown.\n\n See examples at the bottom for a better understanding.","name":"src"},{"type":{"names":["Object"]},"optional":true,"description":"Non-source, static asset files/directories to be\n copied over to build directory; so you can use/link to files such as\n images, ZIPs, PDFs, etc... Keys of this object define the target\n directory, relative to the build destination directory. Value of each\n key can either be a single file path string or an array. This also\n accepts {@link https://github.com/isaacs/node-glob|Glob} strings or\n array of globs. e.g. `{ \"/\": [\"./*.png\"] }` will copy all PNG\n files of the current relative directory to the root of destination\n directory. CAUTION: Each copy operation will overwrite the\n file if it already exists.","name":"assets"},{"type":{"names":["String"]},"description":"Destination output directory path. CAUTION:\n Files in this directory will be overwritten. If `clean` option is\n enabled, all contents will be removed. Make sure you set this to\n a correct path.","name":"dest"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether the destination directory should be\n emptied before the build.","name":"clean"},{"type":{"names":["Boolean","Number"]},"optional":true,"defaultvalue":false,"description":"Specifies debug settings for build\n operation and generated SPA. This takes a bitwise numeric value so\n you can combine flags to your liking. If a `Boolean` value set,\n `false` means `Docma.Debug.DISABLED` and `true` means\n `Docma.Debug.ALL` which enables all debugging options. See\n {@link #Docma.Debug|`Debug` flags enumeration} for all possible\n values.","name":"debug"},{"type":{"names":["Object"]},"optional":true,"description":"JSDoc parse options.","name":"jsdoc"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"utf8\"","description":"Encoding to be used when reading JS\n source files.","name":"jsdoc.encoding"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to recurse into\n sub-directories when scanning for source files.","name":"jsdoc.recurse"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to treat errors as\n fatal errors, and treat warnings as errors.","name":"jsdoc.pedantic"},{"type":{"names":["String","Array"]},"optional":true,"description":"Specifies which symbols to be processed\n with the given access property. Possible values: `\"private\"`,\n `\"protected\"`, `\"public\"` or `\"all\"` (for all access levels). By\n default, all except private symbols are processed. Note that, if\n access is not set for a documented symbol, it will still be included,\n regardless of this option.","name":"jsdoc.access"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"-","name":"jsdoc.private"},{"type":{"names":["String"]},"optional":true,"description":"The path to the `package.json` file that\n contains the project name, version, and other details. If set to\n `true` instead of a path string, the first `package.json` file found\n in the source paths.","name":"jsdoc.package"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Specifies whether to include\n `module.exports` symbols.","name":"jsdoc.module"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to include\n undocumented symbols.","name":"jsdoc.undocumented"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to include\n symbols without a description.","name":"jsdoc.undescribed"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to include symbols\n marked with `ignore` tag.","name":"jsdoc.ignored"},{"type":{"names":["String"]},"optional":true,"description":"When set, all `symbol.meta.path` values\n will be relative to this path.","name":"jsdoc.relativePath"},{"type":{"names":["function"]},"optional":true,"description":"This is used to filter the parsed\n documentation output array. If a `Function` is passed; it's invoked\n for each included `symbol`. e.g. `function (symbol) { return symbol;\n }` Returning a falsy value will remove the symbol from the output.\n Returning `true` will keep the original symbol. To keep the symbol\n and alter its contents, simply return an altered symbol object.","name":"jsdoc.predicate"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Specifies whether to arrange\n symbols by their hierarchy. This will find and move symbols that have\n a `memberof` property to a `$members` property of their corresponding\n owners. Also the constructor symbol will be moved to a `$constructor`\n property of the `ClassDeclaration` symbol; if any.","name":"jsdoc.hierarchy"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":"\"alphabetic\"","description":"Specifies whether to sort\n the documentation symbols. For alphabetic sort, set to `true` or\n `\"alphabetic\"`. To group-sort set to `\"grouped\"`. (Group sorting\n is done in the following order: by memberof, by scope, by access\n type, by kind, alphabetic.) To sort by only `\"scope\"` or\n `\"access\"` or `\"kind\"`, set to corresponding string. (Sorting by\n kind is done in the following order: constant, package/module,\n namespace, class, constructor, method, property, enum, typedef,\n event, interface, mixin, external, other members.) Set to `false`\n to disable. Note that this sorts the documentation symbols data,\n how it's displayed might be altered by the Docma template you're\n using.","name":"jsdoc.sort"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Specifies whether to allow\n unrecognized tags. If set to `false` parsing will fail on unknown\n tags.","name":"jsdoc.allowUnknownTags"},{"type":{"names":["Array"]},"optional":true,"defaultvalue":"[\"jsdoc\", \"closure\"]","description":"Indicates the\n dictionaries to be used. By default, both standard JSDoc tags and\n Closure Compiler tags are enabled.","name":"jsdoc.dictionaries"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\".+\\\\.js(doc|x)?$\"","description":"String pattern for\n defining sources to be included. By default, only files ending in\n `\".js\"`, \"`.jsdoc\"`, and `\".jsx\"` will be processed.","name":"jsdoc.includePattern"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"(^|\\\\/|\\\\\\\\)_\"","description":"String pattern for\n defining sources to be ignored. By default, any file starting with an\n underscore or in a directory starting with an underscore will be\n ignored.","name":"jsdoc.excludePattern"},{"type":{"names":["Array"]},"optional":true,"defaultvalue":"[]","description":"Defines the JSDoc plugins to be used. See\n {@link https://usejsdoc.org/about-plugins.html|this guide} on JSDoc\n plugins.","name":"jsdoc.plugins"},{"type":{"names":["Object"]},"optional":true,"description":"Markdown parse options.","name":"markdown"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to enable\n {@link https://help.github.com/categories/writing-on-github|GitHub flavored markdown}.","name":"markdown.gfm"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to enable enable GFM\n {@link https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables|tables}.\n This option requires the `gfm` option to be `true`.","name":"markdown.tables"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to enable enable GFM\n {@link https://help.github.com/articles/basic-writing-and-formatting-syntax/#paragraphs-and-line-breaks|line breaks}.\n This option requires the `gfm` option to be `true`.","name":"markdown.breaks"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to conform with obscure\n parts of `markdown.pl` as much as possible. Don't fix any of the\n original markdown bugs or poor behavior.","name":"markdown.pedantic"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to use smarter list\n behavior than the original markdown. May eventually be default with\n the old behavior moved into `pedantic`.","name":"markdown.sanitize"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether to use \"smart\"\n typographic punctuation for things like quotes and dashes.","name":"markdown.smartypants"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Self-close the tags for void\n elements (`
`, `![]()
`, etc.) with a `\"/\"` as required by XHTML.","name":"markdown.xhtml"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to parse GitHub style task\n markdown (e.g. `- [x] task`) into checkbox elements.","name":"markdown.tasks"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"If set to `true`, emoji shortcuts\n (e.g. `:smiley:`) are parsed into `<img />` elements\n with {@link https://twitter.github.io/twemoji|twemoji} SVG URLs.","name":"markdown.emoji"},{"type":{"names":["Object"]},"optional":true,"description":"Configuration for the generated SPA (Single Page\n Application).","name":"app"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"\"","description":"Title of the main HTML document of the\n generated web app. (Sets the value of the `<title>` element.)","name":"app.title"},{"type":{"names":["Array","Object"]},"optional":true,"description":"One or more meta elements to be set for the\n main HTML document of the generated web app. Set arbitrary object(s)\n for each meta element to be added. e.g. `[{ charset: \"utf-8\"}, {\n name: \"robots\", \"content\": \"index, follow\" }]`.","name":"app.meta"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"/\"","description":"Sets the base path of the generated web app.\n For example if the app will operate within `/doc/*` set the base path\n to `\"/doc\"`.","name":"app.base"},{"type":{"names":["String"]},"optional":true,"description":"Local path to a `favicon.ico` file to be used\n with the web app.","name":"app.favicon"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"api\"","description":"Defines the home content to be\n displayed for the application root (when you enter the base path i.e.\n `\"/\"`). Pass the type and name of the route in `{type}:{name}`\n format. There are 2 types of routes: `api` for JS source\n documentation and `content` for other HTML content such as parsed\n markdown files. For example, if you have a grouped JS files\n documented with a name `mylib`; to define this as the entrance of the\n app, set this to `\"api:mylib\"`. If you have `\"README.md\"` in your\n source files; to define this as the entrance, set this to\n `\"content:readme\"`.","name":"app.entrance"},{"type":{"names":["String","Object"]},"optional":true,"description":"Either a `String` defining the route\n method or an `Object` defining both the method and whether the routes\n should be case-sensitive.","name":"app.routing"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"query\"","description":"Indicates the routing method for the generated SPA (Single\n Page Application).\n See {@link #Docma.RoutingMethod|`RoutingMethod` enumeration}.","name":"app.routing.method"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Indicates whether the routes should be case-sensitive.\n Note that if this is set to `false`, same route names will\n overwrite the previous, even if they have different case.","name":"app.routing.caseSensitive"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"static\"","description":"Server or host type for the SPA. This\n information helps Docma determine how to configure the generated SPA,\n especially if `routing.method` is set to `\"path\"`. See\n {@link #Docma.ServerType|`ServerType` enumeration} for details.","name":"app.server"},{"type":{"names":["Object"]},"optional":true,"description":"SPA template configuration.","name":"template"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"default\"","description":"Either the path of a custom Docma\n template or the name of a built-in template. Omit to use the default\n built-in template.","name":"template.path"},{"type":{"names":["Object"]},"optional":true,"description":"SPA template options. This is defined by\n the template itself. Refer to the template's documentation for\n options to be set at build-time. See\n {@link templates/zebra/#template-options|Default Template options}.","name":"template.options"}],"examples":["const buildConfig = {\n src: [\n // using an object to define (group) names for JS files.\n {\n // grouping JS files under the name \"my-lib\".\n // This name also defines the api route name: e.g. ?api=my-lib or api/my-lib/\n 'my-lib': [\n './src/** /*.js', // recurse all JS files under /src\n './lib/some-other.js',\n '!./lib/ignored.js' // notice the bang! prefix to exclude this file\n ],\n // naming another api route\n 'other-lib': './other/*.js', // ?api=other-lib\n },\n\n // ungrouped js files will be merged under default route\n './src/main.js', // ?api or ?api=_def_\n './src/main.utils.js', // merged into same ?api or ?api=_def_\n\n // including markdown (\"content\") files\n './CHANGELOG.md', // this will have 'changelog' as route name.\n // i.e. ?content=changelog\n // forcing specific parser on files:\n './LICENSE:md', // LICENSE file with no-extension is forced\n // to markdown via :md suffix.\n // route will be ?content=license or license/\n // using an object to rename the route for the given markdown files\n {\n guide: './README.md' // this will have 'guide' as content route name\n } // i.e. ?content=guide or guide/\n ],\n dest: './output/docs', // output directory for the generated docs\n app: {\n title: 'My Documentation', // title of the app\n routing: 'query', // routing method \"query\" or \"path\"\n entrance: 'content:guide', // initial route to load on entrance\n base: '/' // base path of the SPA\n },\n\n // template-specific configuration.\n // for Zebra template, see https://onury.io/docma/templates/zebra\n template: {\n path: 'zebra',\n options: {\n title: {\n label: 'My Docs',\n href: '/docs/?'\n },\n navbar: true,\n sidebar: {\n enabled: true,\n outline: 'tree'\n }\n }\n }\n };\n // See Docma's own configuration @\n // https://github.com/Prozi/docma/blob/master/docma.json"],"memberof":"Docma","longname":"Docma~BuildConfiguration","scope":"inner","$longname":"Docma~BuildConfiguration","$kind":"typedef","$docmaLink":"api/#Docma~BuildConfiguration"}]},{"comment":"/**\n * Parses the given source files and builds a Single Page Application (SPA)\n * with the given Docma template.\n *\n * For a verbose build, `debug` option should be {@link #Docma.Debug|enabled}.\n *\n * @param {Object|String} config\n * Either a build configuration object or the file path of a\n * configuration JSON file.\n * See {@link #Docma~BuildConfiguration|`BuildConfiguration`} for details.\n *\n * @returns {Promise}\n * Promise that resolves to a `Boolean` value for whether the build\n * operation is successful. This will always return `true` if\n * no errors occur. You should `.catch()` the errors of the\n * promise chain.\n *\n * @example\n * const docma = new Docma();\n * docma.build(config)\n * \t.then(success => {\n * \t\tconsole.log('Documentation is built successfully.');\n * \t})\n * \t.catch(error => {\n * \t\tconsole.log(error.stack);\n * \t});\n */","meta":{"range":[34541,42032],"filename":"Docma.js","lineno":893,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100002720","name":"Docma#build","type":"MethodDefinition","paramnames":["config"]},"vars":{"":null}},"description":"Parses the given source files and builds a Single Page Application (SPA)\n with the given Docma template.\n\n For a verbose build, `debug` option should be {@link #Docma.Debug|enabled}.","params":[{"type":{"names":["Object","String"]},"description":"Either a build configuration object or the file path of a\n configuration JSON file.\n See {@link #Docma~BuildConfiguration|`BuildConfiguration`} for details.","name":"config"}],"returns":[{"type":{"names":["Promise."]},"description":"Promise that resolves to a `Boolean` value for whether the build\n operation is successful. This will always return `true` if\n no errors occur. You should `.catch()` the errors of the\n promise chain."}],"examples":["const docma = new Docma();\n docma.build(config)\n \t.then(success => {\n \t\tconsole.log('Documentation is built successfully.');\n \t})\n \t.catch(error => {\n \t\tconsole.log(error.stack);\n \t});"],"name":"build","longname":"Docma#build","kind":"function","memberof":"Docma","scope":"instance","$longname":"Docma#build","$kind":"method","$docmaLink":"api/#Docma#build"},{"comment":"/**\n * Creates a new instance of `Docma`.\n * This is equivalent to `new Docma()`.\n *\n * @returns {Docma} - Docma instance.\n */","meta":{"range":[42295,42346],"filename":"Docma.js","lineno":1063,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003405","name":"Docma.create","type":"MethodDefinition","paramnames":[]},"vars":{"":null}},"description":"Creates a new instance of `Docma`.\n This is equivalent to `new Docma()`.","returns":[{"type":{"names":["Docma"]},"description":"- Docma instance."}],"name":"create","longname":"Docma.create","kind":"function","memberof":"Docma","scope":"static","params":[],"$longname":"Docma.create","$kind":"method","$docmaLink":"api/#Docma.create"},{"comment":"/**\n * Enumerates bitwise debug flags.\n * @enum {Number}\n */","meta":{"range":[45870,46918],"filename":"Docma.js","lineno":1177,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003447","name":"Docma.Debug","type":"ObjectExpression","value":"{\"DISABLED\":0,\"BUILD_LOGS\":1,\"WEB_LOGS\":2,\"VERBOSE\":4,\"NO_MINIFY\":8,\"JSDOC_OUTPUT\":16,\"ALL\":31}","paramnames":[]}},"description":"Enumerates bitwise debug flags.","kind":"member","isEnum":true,"type":{"names":["Number"]},"name":"Debug","longname":"Docma.Debug","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Enables all debug flags.\n * @type {Number}\n */","meta":{"range":[46908,46915],"filename":"Docma.js","lineno":1217,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003464","name":"ALL","type":"Literal","value":31}},"description":"Enables all debug flags.","type":{"names":["Number"]},"name":"ALL","longname":"Docma.Debug.ALL","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":31},{"comment":"/**\n * Outputs build logs to the Node console.\n * @type {Number}\n */","meta":{"range":[46061,46074],"filename":"Docma.js","lineno":1187,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003454","name":"BUILD_LOGS","type":"Literal","value":1}},"description":"Outputs build logs to the Node console.","type":{"names":["Number"]},"name":"BUILD_LOGS","longname":"Docma.Debug.BUILD_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":1},{"comment":"/**\n * Disables debugging.\n * @type {Number}\n */","meta":{"range":[45957,45968],"filename":"Docma.js","lineno":1182,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003452","name":"DISABLED","type":"Literal","value":0}},"description":"Disables debugging.","type":{"names":["Number"]},"name":"DISABLED","longname":"Docma.Debug.DISABLED","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":0},{"comment":"/**\n * Outputs one or more `[name.]jsdoc.json` files that include\n * documentation data for each (grouped) javascript source.\n * `name` is the group name you give when you define the source\n * files. This is useful for investigating the raw JSDoc output.\n * @type {Number}\n */","meta":{"range":[46814,46830],"filename":"Docma.js","lineno":1212,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003462","name":"JSDOC_OUTPUT","type":"Literal","value":16}},"description":"Outputs one or more `[name.]jsdoc.json` files that include\n documentation data for each (grouped) javascript source.\n `name` is the group name you give when you define the source\n files. This is useful for investigating the raw JSDoc output.","type":{"names":["Number"]},"name":"JSDOC_OUTPUT","longname":"Docma.Debug.JSDOC_OUTPUT","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":16},{"comment":"/**\n * Disables minification for the generated web app assets such as\n * Javascript files. This is useful if you're debugging a custom\n * Docma template.\n * @type {Number}\n */","meta":{"range":[46486,46498],"filename":"Docma.js","lineno":1204,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003460","name":"NO_MINIFY","type":"Literal","value":8}},"description":"Disables minification for the generated web app assets such as\n Javascript files. This is useful if you're debugging a custom\n Docma template.","type":{"names":["Number"]},"name":"NO_MINIFY","longname":"Docma.Debug.NO_MINIFY","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":8},{"comment":"/**\n * Outputs verbose logs to consoles.\n * @type {Number}\n */","meta":{"range":[46266,46276],"filename":"Docma.js","lineno":1197,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003458","name":"VERBOSE","type":"Literal","value":4}},"description":"Outputs verbose logs to consoles.","type":{"names":["Number"]},"name":"VERBOSE","longname":"Docma.Debug.VERBOSE","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":4},{"comment":"/**\n * Outputs app logs to the browser console.\n * @type {Number}\n */","meta":{"range":[46168,46179],"filename":"Docma.js","lineno":1192,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003456","name":"WEB_LOGS","type":"Literal","value":2}},"description":"Outputs app logs to the browser console.","type":{"names":["Number"]},"name":"WEB_LOGS","longname":"Docma.Debug.WEB_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":2}],"$longname":"Docma.Debug","$kind":"enum","$docmaLink":"api/#Docma.Debug","$members":[{"comment":"/**\n * Enables all debug flags.\n * @type {Number}\n */","meta":{"range":[46908,46915],"filename":"Docma.js","lineno":1217,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003464","name":"ALL","type":"Literal","value":31}},"description":"Enables all debug flags.","type":{"names":["Number"]},"name":"ALL","longname":"Docma.Debug.ALL","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":31,"$longname":"Docma.Debug.ALL","$kind":"property","$docmaLink":"api/#Docma.Debug.ALL"},{"comment":"/**\n * Outputs build logs to the Node console.\n * @type {Number}\n */","meta":{"range":[46061,46074],"filename":"Docma.js","lineno":1187,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003454","name":"BUILD_LOGS","type":"Literal","value":1}},"description":"Outputs build logs to the Node console.","type":{"names":["Number"]},"name":"BUILD_LOGS","longname":"Docma.Debug.BUILD_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":1,"$longname":"Docma.Debug.BUILD_LOGS","$kind":"property","$docmaLink":"api/#Docma.Debug.BUILD_LOGS"},{"comment":"/**\n * Disables debugging.\n * @type {Number}\n */","meta":{"range":[45957,45968],"filename":"Docma.js","lineno":1182,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003452","name":"DISABLED","type":"Literal","value":0}},"description":"Disables debugging.","type":{"names":["Number"]},"name":"DISABLED","longname":"Docma.Debug.DISABLED","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":0,"$longname":"Docma.Debug.DISABLED","$kind":"property","$docmaLink":"api/#Docma.Debug.DISABLED"},{"comment":"/**\n * Outputs one or more `[name.]jsdoc.json` files that include\n * documentation data for each (grouped) javascript source.\n * `name` is the group name you give when you define the source\n * files. This is useful for investigating the raw JSDoc output.\n * @type {Number}\n */","meta":{"range":[46814,46830],"filename":"Docma.js","lineno":1212,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003462","name":"JSDOC_OUTPUT","type":"Literal","value":16}},"description":"Outputs one or more `[name.]jsdoc.json` files that include\n documentation data for each (grouped) javascript source.\n `name` is the group name you give when you define the source\n files. This is useful for investigating the raw JSDoc output.","type":{"names":["Number"]},"name":"JSDOC_OUTPUT","longname":"Docma.Debug.JSDOC_OUTPUT","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":16,"$longname":"Docma.Debug.JSDOC_OUTPUT","$kind":"property","$docmaLink":"api/#Docma.Debug.JSDOC_OUTPUT"},{"comment":"/**\n * Disables minification for the generated web app assets such as\n * Javascript files. This is useful if you're debugging a custom\n * Docma template.\n * @type {Number}\n */","meta":{"range":[46486,46498],"filename":"Docma.js","lineno":1204,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003460","name":"NO_MINIFY","type":"Literal","value":8}},"description":"Disables minification for the generated web app assets such as\n Javascript files. This is useful if you're debugging a custom\n Docma template.","type":{"names":["Number"]},"name":"NO_MINIFY","longname":"Docma.Debug.NO_MINIFY","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":8,"$longname":"Docma.Debug.NO_MINIFY","$kind":"property","$docmaLink":"api/#Docma.Debug.NO_MINIFY"},{"comment":"/**\n * Outputs verbose logs to consoles.\n * @type {Number}\n */","meta":{"range":[46266,46276],"filename":"Docma.js","lineno":1197,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003458","name":"VERBOSE","type":"Literal","value":4}},"description":"Outputs verbose logs to consoles.","type":{"names":["Number"]},"name":"VERBOSE","longname":"Docma.Debug.VERBOSE","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":4,"$longname":"Docma.Debug.VERBOSE","$kind":"property","$docmaLink":"api/#Docma.Debug.VERBOSE"},{"comment":"/**\n * Outputs app logs to the browser console.\n * @type {Number}\n */","meta":{"range":[46168,46179],"filename":"Docma.js","lineno":1192,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003456","name":"WEB_LOGS","type":"Literal","value":2}},"description":"Outputs app logs to the browser console.","type":{"names":["Number"]},"name":"WEB_LOGS","longname":"Docma.Debug.WEB_LOGS","kind":"member","memberof":"Docma.Debug","scope":"static","defaultvalue":2,"$longname":"Docma.Debug.WEB_LOGS","$kind":"property","$docmaLink":"api/#Docma.Debug.WEB_LOGS"}]},{"comment":"/**\n * Enumerates Docma SPA route types.\n * @enum {String}\n * @readonly\n *\n * @example Routing Method: \"query\" \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ ?api\n * api web ?api=web\n * content templates ?content=templates\n * content guide ?content=guide\n *\n * @example Routing Method: \"path\" \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ api/\n * api web api/web/\n * content templates templates/\n * content guide guide/\n */","meta":{"range":[44302,44653],"filename":"Docma.js","lineno":1121,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003423","name":"Docma.RouteType","type":"ObjectExpression","value":"{\"API\":\"api\",\"CONTENT\":\"content\"}","paramnames":[]}},"description":"Enumerates Docma SPA route types.","kind":"member","isEnum":true,"type":{"names":["String"]},"readonly":true,"examples":["Routing Method: \"query\" \n type name path\n ------- ---------------- --------------------------\n api _def_ ?api\n api web ?api=web\n content templates ?content=templates\n content guide ?content=guide\n\n ","Routing Method: \"path\" \n type name path\n ------- ---------------- --------------------------\n api _def_ api/\n api web api/web/\n content templates templates/\n content guide guide/"],"name":"RouteType","longname":"Docma.RouteType","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Indicates a route for API documentation content, generated from\n * Javascript source files via JSDoc.\n * @type {String}\n */","meta":{"range":[44480,44490],"filename":"Docma.js","lineno":1127,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003428","name":"API","type":"Literal","value":"api"}},"description":"Indicates a route for API documentation content, generated from\n Javascript source files via JSDoc.","type":{"names":["String"]},"name":"API","longname":"Docma.RouteType.API","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"api"},{"comment":"/**\n * Indicates a route for other content, such as HTML files generated\n * from markdown.\n * @type {String}\n */","meta":{"range":[44632,44650],"filename":"Docma.js","lineno":1133,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003430","name":"CONTENT","type":"Literal","value":"content"}},"description":"Indicates a route for other content, such as HTML files generated\n from markdown.","type":{"names":["String"]},"name":"CONTENT","longname":"Docma.RouteType.CONTENT","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"content"}],"$longname":"Docma.RouteType","$kind":"enum","$docmaLink":"api/#Docma.RouteType","$members":[{"comment":"/**\n * Indicates a route for API documentation content, generated from\n * Javascript source files via JSDoc.\n * @type {String}\n */","meta":{"range":[44480,44490],"filename":"Docma.js","lineno":1127,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003428","name":"API","type":"Literal","value":"api"}},"description":"Indicates a route for API documentation content, generated from\n Javascript source files via JSDoc.","type":{"names":["String"]},"name":"API","longname":"Docma.RouteType.API","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"api","$longname":"Docma.RouteType.API","$kind":"property","$docmaLink":"api/#Docma.RouteType.API"},{"comment":"/**\n * Indicates a route for other content, such as HTML files generated\n * from markdown.\n * @type {String}\n */","meta":{"range":[44632,44650],"filename":"Docma.js","lineno":1133,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003430","name":"CONTENT","type":"Literal","value":"content"}},"description":"Indicates a route for other content, such as HTML files generated\n from markdown.","type":{"names":["String"]},"name":"CONTENT","longname":"Docma.RouteType.CONTENT","kind":"member","memberof":"Docma.RouteType","scope":"static","defaultvalue":"content","$longname":"Docma.RouteType.CONTENT","$kind":"property","$docmaLink":"api/#Docma.RouteType.CONTENT"}]},{"comment":"/**\n * Enumerates the routing methods for a Docma generated web application.\n * @enum {String}\n * @readonly\n */","meta":{"range":[42556,43561],"filename":"Docma.js","lineno":1077,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003413","name":"Docma.RoutingMethod","type":"ObjectExpression","value":"{\"QUERY\":\"query\",\"PATH\":\"path\"}","paramnames":[]}},"description":"Enumerates the routing methods for a Docma generated web application.","kind":"member","isEnum":true,"type":{"names":["String"]},"readonly":true,"name":"RoutingMethod","longname":"Docma.RoutingMethod","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Indicates that the SPA routes are based on path params rather than\n * query-strings. For example, for a named group of JS source files\n * (e.g. `\"mylib\"`), the generated documentation will be accessible at\n * `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `readme/`.\n * @type {String}\n */","meta":{"range":[43546,43558],"filename":"Docma.js","lineno":1097,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003420","name":"PATH","type":"Literal","value":"path"}},"description":"Indicates that the SPA routes are based on path params rather than\n query-strings. For example, for a named group of JS source files\n (e.g. `\"mylib\"`), the generated documentation will be accessible at\n `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `readme/`.","type":{"names":["String"]},"name":"PATH","longname":"Docma.RoutingMethod.PATH","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"path"},{"comment":"/**\n * Indicates that the SPA routes are based on query-strings.\n * For example, for a named group of JS source files (e.g. `\"mylib\"`),\n * the generated documentation will be accessible at `?api=mylib`.\n * Ungrouped JS documentation will be accessible at `?api`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `?content=readme`.\n * @type {String}\n */","meta":{"range":[43047,43061],"filename":"Docma.js","lineno":1087,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003418","name":"QUERY","type":"Literal","value":"query"}},"description":"Indicates that the SPA routes are based on query-strings.\n For example, for a named group of JS source files (e.g. `\"mylib\"`),\n the generated documentation will be accessible at `?api=mylib`.\n Ungrouped JS documentation will be accessible at `?api`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `?content=readme`.","type":{"names":["String"]},"name":"QUERY","longname":"Docma.RoutingMethod.QUERY","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"query"}],"$longname":"Docma.RoutingMethod","$kind":"enum","$docmaLink":"api/#Docma.RoutingMethod","$members":[{"comment":"/**\n * Indicates that the SPA routes are based on path params rather than\n * query-strings. For example, for a named group of JS source files\n * (e.g. `\"mylib\"`), the generated documentation will be accessible at\n * `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `readme/`.\n * @type {String}\n */","meta":{"range":[43546,43558],"filename":"Docma.js","lineno":1097,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003420","name":"PATH","type":"Literal","value":"path"}},"description":"Indicates that the SPA routes are based on path params rather than\n query-strings. For example, for a named group of JS source files\n (e.g. `\"mylib\"`), the generated documentation will be accessible at\n `api/mylib/`. Ungrouped JS documentation will be accessible at `api/`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `readme/`.","type":{"names":["String"]},"name":"PATH","longname":"Docma.RoutingMethod.PATH","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"path","$longname":"Docma.RoutingMethod.PATH","$kind":"property","$docmaLink":"api/#Docma.RoutingMethod.PATH"},{"comment":"/**\n * Indicates that the SPA routes are based on query-strings.\n * For example, for a named group of JS source files (e.g. `\"mylib\"`),\n * the generated documentation will be accessible at `?api=mylib`.\n * Ungrouped JS documentation will be accessible at `?api`.\n * And for other HTML content such as files generated from markdown\n * files (e.g. README.md) will be accessible at `?content=readme`.\n * @type {String}\n */","meta":{"range":[43047,43061],"filename":"Docma.js","lineno":1087,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003418","name":"QUERY","type":"Literal","value":"query"}},"description":"Indicates that the SPA routes are based on query-strings.\n For example, for a named group of JS source files (e.g. `\"mylib\"`),\n the generated documentation will be accessible at `?api=mylib`.\n Ungrouped JS documentation will be accessible at `?api`.\n And for other HTML content such as files generated from markdown\n files (e.g. README.md) will be accessible at `?content=readme`.","type":{"names":["String"]},"name":"QUERY","longname":"Docma.RoutingMethod.QUERY","kind":"member","memberof":"Docma.RoutingMethod","scope":"static","defaultvalue":"query","$longname":"Docma.RoutingMethod.QUERY","$kind":"property","$docmaLink":"api/#Docma.RoutingMethod.QUERY"}]},{"comment":"/**\n * Enumerates the server/host types for Docma generated SPA.\n * The generated SPA is not limited to these hosts but Docma will generate\n * additional server config files for these hosts; especially if the\n * routing method is set to `\"path\"`. For example, for Apache;\n * an `.htaccess` file will be auto-generated with redirect rules for\n * (sub) routes. For GitHub, sub-directories will be generated\n * (just like Jekyll) with index files for redirecting via http-meta\n * refresh.\n * @enum {String}\n * @readonly\n */","meta":{"range":[45187,45804],"filename":"Docma.js","lineno":1148,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003433","name":"Docma.ServerType","type":"ObjectExpression","value":"{\"APACHE\":\"apache\",\"GITHUB\":\"github\",\"STATIC\":\"static\",\"WINDOWS\":\"windows\"}","paramnames":[]}},"description":"Enumerates the server/host types for Docma generated SPA.\n The generated SPA is not limited to these hosts but Docma will generate\n additional server config files for these hosts; especially if the\n routing method is set to `\"path\"`. For example, for Apache;\n an `.htaccess` file will be auto-generated with redirect rules for\n (sub) routes. For GitHub, sub-directories will be generated\n (just like Jekyll) with index files for redirecting via http-meta\n refresh.","kind":"member","isEnum":true,"type":{"names":["String"]},"readonly":true,"name":"ServerType","longname":"Docma.ServerType","memberof":"Docma","scope":"static","properties":[{"comment":"/**\n * Indicates that an Apache server will be hosting the generated SPA.\n * @type {String}\n */","meta":{"range":[45326,45342],"filename":"Docma.js","lineno":1153,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003438","name":"APACHE","type":"Literal","value":"apache"}},"description":"Indicates that an Apache server will be hosting the generated SPA.","type":{"names":["String"]},"name":"APACHE","longname":"Docma.ServerType.APACHE","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"apache"},{"comment":"/**\n * Indicates that SPA will be hosted via\n * {@link https://pages.github.com|GitHub Pages}.\n * @type {String}\n */","meta":{"range":[45488,45504],"filename":"Docma.js","lineno":1159,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003440","name":"GITHUB","type":"Literal","value":"github"}},"description":"Indicates that SPA will be hosted via\n {@link https://pages.github.com|GitHub Pages}.","type":{"names":["String"]},"name":"GITHUB","longname":"Docma.ServerType.GITHUB","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"github"},{"comment":"/**\n * Indicates that SPA will be hosted as static HTML files.\n * Similar to `Docma.ServerType.GITHUB`.\n * @type {String}\n */","meta":{"range":[45659,45675],"filename":"Docma.js","lineno":1165,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003442","name":"STATIC","type":"Literal","value":"static"}},"description":"Indicates that SPA will be hosted as static HTML files.\n Similar to `Docma.ServerType.GITHUB`.","type":{"names":["String"]},"name":"STATIC","longname":"Docma.ServerType.STATIC","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"static"},{"comment":"/**\n * Indicates that SPA will be hosted on a Windows server.\n * @type {String}\n */","meta":{"range":[45783,45801],"filename":"Docma.js","lineno":1170,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003444","name":"WINDOWS","type":"Literal","value":"windows"}},"description":"Indicates that SPA will be hosted on a Windows server.","type":{"names":["String"]},"name":"WINDOWS","longname":"Docma.ServerType.WINDOWS","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"windows"}],"$longname":"Docma.ServerType","$kind":"enum","$docmaLink":"api/#Docma.ServerType","$members":[{"comment":"/**\n * Indicates that an Apache server will be hosting the generated SPA.\n * @type {String}\n */","meta":{"range":[45326,45342],"filename":"Docma.js","lineno":1153,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003438","name":"APACHE","type":"Literal","value":"apache"}},"description":"Indicates that an Apache server will be hosting the generated SPA.","type":{"names":["String"]},"name":"APACHE","longname":"Docma.ServerType.APACHE","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"apache","$longname":"Docma.ServerType.APACHE","$kind":"property","$docmaLink":"api/#Docma.ServerType.APACHE"},{"comment":"/**\n * Indicates that SPA will be hosted via\n * {@link https://pages.github.com|GitHub Pages}.\n * @type {String}\n */","meta":{"range":[45488,45504],"filename":"Docma.js","lineno":1159,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003440","name":"GITHUB","type":"Literal","value":"github"}},"description":"Indicates that SPA will be hosted via\n {@link https://pages.github.com|GitHub Pages}.","type":{"names":["String"]},"name":"GITHUB","longname":"Docma.ServerType.GITHUB","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"github","$longname":"Docma.ServerType.GITHUB","$kind":"property","$docmaLink":"api/#Docma.ServerType.GITHUB"},{"comment":"/**\n * Indicates that SPA will be hosted as static HTML files.\n * Similar to `Docma.ServerType.GITHUB`.\n * @type {String}\n */","meta":{"range":[45659,45675],"filename":"Docma.js","lineno":1165,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003442","name":"STATIC","type":"Literal","value":"static"}},"description":"Indicates that SPA will be hosted as static HTML files.\n Similar to `Docma.ServerType.GITHUB`.","type":{"names":["String"]},"name":"STATIC","longname":"Docma.ServerType.STATIC","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"static","$longname":"Docma.ServerType.STATIC","$kind":"property","$docmaLink":"api/#Docma.ServerType.STATIC"},{"comment":"/**\n * Indicates that SPA will be hosted on a Windows server.\n * @type {String}\n */","meta":{"range":[45783,45801],"filename":"Docma.js","lineno":1170,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003444","name":"WINDOWS","type":"Literal","value":"windows"}},"description":"Indicates that SPA will be hosted on a Windows server.","type":{"names":["String"]},"name":"WINDOWS","longname":"Docma.ServerType.WINDOWS","kind":"member","memberof":"Docma.ServerType","scope":"static","defaultvalue":"windows","$longname":"Docma.ServerType.WINDOWS","$kind":"property","$docmaLink":"api/#Docma.ServerType.WINDOWS"}]},{"comment":"/**\n * This class is useful for template authors only.
\n *\n * Class that provides template information and methods for supporting the\n * documentation build process.\n *\n * You should not instantiate this class directly with a `new` operator. Docma\n * passes an instance of this class to your template module as the first\n * argument; when the end-user builds their documentation.\n *\n * See {@link templates/guide/|Creating Docma Templates}.\n * You can also use {@link cli/#docma-template-init--path-|Docma CLI}\n * to initialize a new Docma template project. i.e. `docma template init`. This will\n * generate most files required to author a template; including a main JS file for\n * your module; as shown below in the example.\n *\n * @class\n * @name Docma.Template\n * @since 2.0.0\n *\n * @example Custom template module implementation \n * module.exports = (template, modules) => {\n *\n * // Docma also passes some useful modules (which it already uses internally);\n * // so you don't have to add them to your template module as dependencies.\n * // modules: _ (Lodash), Promise (Bluebird), fs (fs-extra), dust, HtmlParser, utils\n * const { Promise } = modules;\n *\n * template.mainHTML = 'index.html';\n *\n * template.defaultOptions = {\n * // whatever options your template has...\n * title: 'Docs',\n * searchEnabled: true\n * };\n *\n * template.preBuild(() => {\n * // Do some stuff —before— Docma builds documentation for the end-user...\n * return Promise.resolve();\n * });\n *\n * template.postBuild(() => {\n * // Do some stuff —after— the build completes...\n * return Promise.resolve();\n * });\n * };\n */","meta":{"filename":"Template.js","lineno":18,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"This class is useful for template authors only.
\n\n Class that provides template information and methods for supporting the\n documentation build process.\n\n You should not instantiate this class directly with a `new` operator. Docma\n passes an instance of this class to your template module as the first\n argument; when the end-user builds their documentation.\n\n See {@link templates/guide/|Creating Docma Templates}.\n You can also use {@link cli/#docma-template-init--path-|Docma CLI}\n to initialize a new Docma template project. i.e. `docma template init`. This will\n generate most files required to author a template; including a main JS file for\n your module; as shown below in the example.","kind":"class","name":"Template","since":"2.0.0","examples":["Custom template module implementation \n module.exports = (template, modules) => {\n\n // Docma also passes some useful modules (which it already uses internally);\n // so you don't have to add them to your template module as dependencies.\n // modules: _ (Lodash), Promise (Bluebird), fs (fs-extra), dust, HtmlParser, utils\n const { Promise } = modules;\n\n template.mainHTML = 'index.html';\n\n template.defaultOptions = {\n // whatever options your template has...\n title: 'Docs',\n searchEnabled: true\n };\n\n template.preBuild(() => {\n // Do some stuff —before— Docma builds documentation for the end-user...\n return Promise.resolve();\n });\n\n template.postBuild(() => {\n // Do some stuff —after— the build completes...\n return Promise.resolve();\n });\n };"],"memberof":"Docma","longname":"Docma.Template","scope":"static","$longname":"Docma.Template","$kind":"class","$docmaLink":"api/#Docma.Template","$members":[{"comment":"/**\n * Gets the author of the template.\n * @type {String}\n * @name Docma.Template#author\n */","meta":{"filename":"Template.js","lineno":176,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the author of the template.","type":{"names":["String"]},"name":"author","memberof":"Docma.Template","longname":"Docma.Template#author","scope":"instance","kind":"member","$longname":"Docma.Template#author","$kind":"property","$docmaLink":"api/#Docma.Template#author"},{"comment":"/**\n * Gets the build configuration used when building documentation with this\n * template.\n * @type {Docma~BuildConfiguration}\n * @name Docma.Template#buildConfig\n */","meta":{"filename":"Template.js","lineno":221,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the build configuration used when building documentation with this\n template.","type":{"names":["Docma~BuildConfiguration"]},"name":"buildConfig","memberof":"Docma.Template","longname":"Docma.Template#buildConfig","scope":"instance","kind":"member","$longname":"Docma.Template#buildConfig","$kind":"property","$docmaLink":"api/#Docma.Template#buildConfig"},{"comment":"/**\n * Gets the simple debugger/logger used by Dogma.\n * @type {Docma~Debug}\n * @name Docma.Template#debug\n */","meta":{"filename":"Template.js","lineno":231,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the simple debugger/logger used by Dogma.","type":{"names":["Docma~Debug"]},"name":"debug","memberof":"Docma.Template","longname":"Docma.Template#debug","scope":"instance","kind":"member","$longname":"Docma.Template#debug","$kind":"property","$docmaLink":"api/#Docma.Template#debug"},{"comment":"/**\n * Gets or sets the default options of the template.\n * Default options can be set within the module main JS file or via\n * `docmaTemplate.defaultOptions` within template's package.json.\n * @type {Object}\n * @name Docma.Template#defaultOptions\n */","meta":{"filename":"Template.js","lineno":240,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets or sets the default options of the template.\n Default options can be set within the module main JS file or via\n `docmaTemplate.defaultOptions` within template's package.json.","type":{"names":["Object"]},"name":"defaultOptions","memberof":"Docma.Template","longname":"Docma.Template#defaultOptions","scope":"instance","kind":"member","$longname":"Docma.Template#defaultOptions","$kind":"property","$docmaLink":"api/#Docma.Template#defaultOptions"},{"comment":"/**\n * Gets the description of the template.\n * @type {String}\n * @name Docma.Template#description\n */","meta":{"filename":"Template.js","lineno":138,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the description of the template.","type":{"names":["String"]},"name":"description","memberof":"Docma.Template","longname":"Docma.Template#description","scope":"instance","kind":"member","$longname":"Docma.Template#description","$kind":"property","$docmaLink":"api/#Docma.Template#description"},{"comment":"/**\n * Gets the dirname of the template.\n * @type {String}\n * @name Docma.Template#dirname\n */","meta":{"filename":"Template.js","lineno":203,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the dirname of the template.","type":{"names":["String"]},"name":"dirname","memberof":"Docma.Template","longname":"Docma.Template#dirname","scope":"instance","kind":"member","$longname":"Docma.Template#dirname","$kind":"property","$docmaLink":"api/#Docma.Template#dirname"},{"comment":"/**\n * Gets Docma version, template is built with.\n * @type {String}\n * @name Docma.Template#docmaVersion\n */","meta":{"filename":"Template.js","lineno":156,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets Docma version, template is built with.","type":{"names":["String"]},"name":"docmaVersion","memberof":"Docma.Template","longname":"Docma.Template#docmaVersion","scope":"instance","kind":"member","$longname":"Docma.Template#docmaVersion","$kind":"property","$docmaLink":"api/#Docma.Template#docmaVersion"},{"comment":"/**\n * Convenience method for joining and getting the destination path within\n * build (output) directory for the given string(s).\n * @name Docma.Template#getDestPath\n * @function\n * @param {...String} [args=\"\"] - String arguments of path sections.\n * @returns {String} -\n */","meta":{"filename":"Template.js","lineno":328,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Convenience method for joining and getting the destination path within\n build (output) directory for the given string(s).","name":"getDestPath","kind":"function","params":[{"type":{"names":["String"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"String arguments of path sections.","name":"args"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"Docma.Template","longname":"Docma.Template#getDestPath","scope":"instance","$longname":"Docma.Template#getDestPath","$kind":"method","$docmaLink":"api/#Docma.Template#getDestPath"},{"comment":"/**\n * Convenience method for joining and getting the source path within\n * `/template` directory for the given string(s).\n * @name Docma.Template#getSrcPath\n * @function\n * @param {...String} [args=\"\"] - String arguments of path sections.\n * @returns {String} -\n */","meta":{"filename":"Template.js","lineno":316,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Convenience method for joining and getting the source path within\n `/template` directory for the given string(s).","name":"getSrcPath","kind":"function","params":[{"type":{"names":["String"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"String arguments of path sections.","name":"args"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"Docma.Template","longname":"Docma.Template#getSrcPath","scope":"instance","$longname":"Docma.Template#getSrcPath","$kind":"method","$docmaLink":"api/#Docma.Template#getSrcPath"},{"comment":"/**\n * Gets or sets array of ignored files when building documentation with\n * this template. Ignored files can be set within the module main JS file\n * or via `docmaTemplate.ignore` within template's package.json.\n * @type {Array}\n * @name Docma.Template#ignore\n */","meta":{"filename":"Template.js","lineno":291,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets or sets array of ignored files when building documentation with\n this template. Ignored files can be set within the module main JS file\n or via `docmaTemplate.ignore` within template's package.json.","type":{"names":["Array"]},"name":"ignore","memberof":"Docma.Template","longname":"Docma.Template#ignore","scope":"instance","kind":"member","$longname":"Docma.Template#ignore","$kind":"property","$docmaLink":"api/#Docma.Template#ignore"},{"comment":"/**\n * Gets the license of the template.\n * @type {String}\n * @name Docma.Template#license\n */","meta":{"filename":"Template.js","lineno":185,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the license of the template.","type":{"names":["String"]},"name":"license","memberof":"Docma.Template","longname":"Docma.Template#license","scope":"instance","kind":"member","$longname":"Docma.Template#license","$kind":"property","$docmaLink":"api/#Docma.Template#license"},{"comment":"/**\n * Outputs a data log to the console. For more logger/debugger methods, use\n * {@link api/#Docma.Template#debug|`#debug`} object.\n * @name Docma.Template#log\n * @function\n * @param {...String} [args=\"\"] - String arguments to be logged.\n */","meta":{"filename":"Template.js","lineno":305,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Outputs a data log to the console. For more logger/debugger methods, use\n {@link api/#Docma.Template#debug|`#debug`} object.","name":"log","kind":"function","params":[{"type":{"names":["String"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"String arguments to be logged.","name":"args"}],"memberof":"Docma.Template","longname":"Docma.Template#log","scope":"instance","$longname":"Docma.Template#log","$kind":"method","$docmaLink":"api/#Docma.Template#log"},{"comment":"/**\n * Gets or sets the main HTML file (name) of the template.\n * Main HTML file can be set within the module main JS file or via\n * `docmaTemplate.mainHTML` within template's package.json.\n * @type {String}\n * @name Docma.Template#mainHTML\n */","meta":{"filename":"Template.js","lineno":275,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets or sets the main HTML file (name) of the template.\n Main HTML file can be set within the module main JS file or via\n `docmaTemplate.mainHTML` within template's package.json.","type":{"names":["String"]},"name":"mainHTML","memberof":"Docma.Template","longname":"Docma.Template#mainHTML","scope":"instance","kind":"member","$longname":"Docma.Template#mainHTML","$kind":"property","$docmaLink":"api/#Docma.Template#mainHTML"},{"comment":"/**\n * Gets the name of the template.\n * @type {String}\n * @name Docma.Template#name\n */","meta":{"filename":"Template.js","lineno":129,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the name of the template.","type":{"names":["String"]},"name":"name","memberof":"Docma.Template","longname":"Docma.Template#name","scope":"instance","kind":"member","$longname":"Docma.Template#name","$kind":"property","$docmaLink":"api/#Docma.Template#name"},{"comment":"/**\n * Gets or sets the template options set by the user when building\n * documentation with this template.\n * @type {Object}\n * @name Docma.Template#options\n */","meta":{"filename":"Template.js","lineno":262,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets or sets the template options set by the user when building\n documentation with this template.","type":{"names":["Object"]},"name":"options","memberof":"Docma.Template","longname":"Docma.Template#options","scope":"instance","kind":"member","$longname":"Docma.Template#options","$kind":"property","$docmaLink":"api/#Docma.Template#options"},{"comment":"/**\n * Gets the path of the template.\n * @type {String}\n * @name Docma.Template#path\n */","meta":{"filename":"Template.js","lineno":194,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the path of the template.","type":{"names":["String"]},"name":"path","memberof":"Docma.Template","longname":"Docma.Template#path","scope":"instance","kind":"member","$longname":"Docma.Template#path","$kind":"property","$docmaLink":"api/#Docma.Template#path"},{"comment":"/**\n * Gets the package.json contents of the template.\n * @type {Object}\n * @name Docma.Template#pkg\n */","meta":{"filename":"Template.js","lineno":120,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the package.json contents of the template.","type":{"names":["Object"]},"name":"pkg","memberof":"Docma.Template","longname":"Docma.Template#pkg","scope":"instance","kind":"member","$longname":"Docma.Template#pkg","$kind":"property","$docmaLink":"api/#Docma.Template#pkg"},{"comment":"/**\n * Sets a post-build processor function that is ran right after Docma build\n * completes.\n * @name Docma.Template#postBuild\n * @function\n * @param {Function} fn - Processor function. You can return a `Promise` if\n * this is an async operation.\n */","meta":{"filename":"Template.js","lineno":352,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Sets a post-build processor function that is ran right after Docma build\n completes.","name":"postBuild","kind":"function","params":[{"type":{"names":["function"]},"description":"Processor function. You can return a `Promise` if\n this is an async operation.","name":"fn"}],"memberof":"Docma.Template","longname":"Docma.Template#postBuild","scope":"instance","$longname":"Docma.Template#postBuild","$kind":"method","$docmaLink":"api/#Docma.Template#postBuild"},{"comment":"/**\n * Sets a pre-build processor function that is ran right before Docma build\n * starts.\n * @name Docma.Template#preBuild\n * @function\n * @param {Function} fn - Processor function. You can return a `Promise` if\n * this is an async operation.\n */","meta":{"filename":"Template.js","lineno":340,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Sets a pre-build processor function that is ran right before Docma build\n starts.","name":"preBuild","kind":"function","params":[{"type":{"names":["function"]},"description":"Processor function. You can return a `Promise` if\n this is an async operation.","name":"fn"}],"memberof":"Docma.Template","longname":"Docma.Template#preBuild","scope":"instance","$longname":"Docma.Template#preBuild","$kind":"method","$docmaLink":"api/#Docma.Template#preBuild"},{"comment":"/**\n * Gets Docma version (range) supported by this template.\n * This is set via `peerDependencies` in package.json.\n * If omitted, returns `\">=2.0.0\"`.\n * @type {String}\n * @name Docma.Template#supportedDocmaVersion\n */","meta":{"filename":"Template.js","lineno":165,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets Docma version (range) supported by this template.\n This is set via `peerDependencies` in package.json.\n If omitted, returns `\">=2.0.0\"`.","type":{"names":["String"]},"name":"supportedDocmaVersion","memberof":"Docma.Template","longname":"Docma.Template#supportedDocmaVersion","scope":"instance","kind":"member","$longname":"Docma.Template#supportedDocmaVersion","$kind":"property","$docmaLink":"api/#Docma.Template#supportedDocmaVersion"},{"comment":"/**\n * Gets the path of the template directory within the template.\n * @type {String}\n * @name Docma.Template#templateDir\n */","meta":{"filename":"Template.js","lineno":212,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the path of the template directory within the template.","type":{"names":["String"]},"name":"templateDir","memberof":"Docma.Template","longname":"Docma.Template#templateDir","scope":"instance","kind":"member","$longname":"Docma.Template#templateDir","$kind":"property","$docmaLink":"api/#Docma.Template#templateDir"},{"comment":"/**\n * Gets the version of the template.\n * @type {String}\n * @name Docma.Template#version\n */","meta":{"filename":"Template.js","lineno":147,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the version of the template.","type":{"names":["String"]},"name":"version","memberof":"Docma.Template","longname":"Docma.Template#version","scope":"instance","kind":"member","$longname":"Docma.Template#version","$kind":"property","$docmaLink":"api/#Docma.Template#version"}]},{"comment":"/**\n * This class is useful for template authors only.
\n *\n * Class that runs diagnostics on a target Docma template by analyzing\n * the file structure, validating package metadata and testing with the\n * template builder.\n *\n * @class\n * @name TemplateDoctor\n * @memberof Docma\n * @since 2.0.0\n */","meta":{"filename":"TemplateDoctor.js","lineno":70,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"This class is useful for template authors only.
\n\n Class that runs diagnostics on a target Docma template by analyzing\n the file structure, validating package metadata and testing with the\n template builder.","kind":"class","name":"TemplateDoctor","memberof":"Docma","since":"2.0.0","scope":"static","longname":"Docma.TemplateDoctor","$longname":"Docma.TemplateDoctor","$kind":"class","$docmaLink":"api/#Docma.TemplateDoctor","$members":[{"comment":"/**\n * Analyzes the Docma template and collects diagnostics information on the\n * template structure, package health and builder initialization.\n * @name Docma.TemplateDoctor#diagnose\n * @method\n *\n * @returns {Object} - Diagnostics data.\n */","meta":{"filename":"TemplateDoctor.js","lineno":327,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Analyzes the Docma template and collects diagnostics information on the\n template structure, package health and builder initialization.","name":"diagnose","kind":"function","returns":[{"type":{"names":["Object"]},"description":"- Diagnostics data."}],"memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#diagnose","scope":"instance","$longname":"Docma.TemplateDoctor#diagnose","$kind":"method","$docmaLink":"api/#Docma.TemplateDoctor#diagnose"},{"comment":"/**\n * Gets the diagnostics data object that contains the results.\n * @type {Object}\n * @name Docma.TemplateDoctor#diagnostics\n */","meta":{"filename":"TemplateDoctor.js","lineno":145,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the diagnostics data object that contains the results.","type":{"names":["Object"]},"name":"diagnostics","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#diagnostics","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#diagnostics","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#diagnostics"},{"comment":"/**\n * Gets the package.json contents of the Docma template anayzed.\n * @type {Object}\n * @name Docma.TemplateDoctor#pkg\n */","meta":{"filename":"TemplateDoctor.js","lineno":117,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the package.json contents of the Docma template anayzed.","type":{"names":["Object"]},"name":"pkg","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#pkg","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#pkg","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#pkg"},{"comment":"/**\n * Resets the state of the TemplateDoctor instance, cleaning up\n * previous diagnosis information and data. (Note that settings are not\n * reset.)\n * @name Docma.TemplateDoctor#reset\n * @method\n */","meta":{"filename":"TemplateDoctor.js","lineno":382,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Resets the state of the TemplateDoctor instance, cleaning up\n previous diagnosis information and data. (Note that settings are not\n reset.)","name":"reset","kind":"function","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#reset","scope":"instance","$longname":"Docma.TemplateDoctor#reset","$kind":"method","$docmaLink":"api/#Docma.TemplateDoctor#reset"},{"comment":"/**\n * Gets or sets the diagnostics settings.\n * @type {Object}\n * @name Docma.TemplateDoctor#settings\n */","meta":{"filename":"TemplateDoctor.js","lineno":154,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets or sets the diagnostics settings.","type":{"names":["Object"]},"name":"settings","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#settings","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#settings","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#settings"},{"comment":"/**\n * Gets the template instance created while diagnosing. In other words,\n * template instance is only available after `.diagnose()` is called.\n * @type {Docma.Template}\n * @name Docma.TemplateDoctor#template\n */","meta":{"filename":"TemplateDoctor.js","lineno":135,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the template instance created while diagnosing. In other words,\n template instance is only available after `.diagnose()` is called.","type":{"names":["Docma.Template"]},"name":"template","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#template","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#template","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#template"},{"comment":"/**\n * Gets the name of the Docma template.\n * @type {String}\n * @name Docma.TemplateDoctor#templateName\n */","meta":{"filename":"TemplateDoctor.js","lineno":126,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{}},"description":"Gets the name of the Docma template.","type":{"names":["String"]},"name":"templateName","memberof":"Docma.TemplateDoctor","longname":"Docma.TemplateDoctor#templateName","scope":"instance","kind":"member","$longname":"Docma.TemplateDoctor#templateName","$kind":"property","$docmaLink":"api/#Docma.TemplateDoctor#templateName"}],"$constructor":{"comment":"/**\n * Initializes a new instance of `Docma.TemplateDoctor`.\n * @constructs Docma.TemplateDoctor\n *\n * @param {String} templatePath - Path of the template to be diagnosed.\n * @param {Object} [settings={}] - Diagnose settings.\n * @param {Boolean} [settings.quiet=true] - Whether not to log\n * diagnostics information to console.\n * @param {Boolean} [settings.stopOnFirstFailure=false] - Whether\n * to stop on first failure.\n */","meta":{"range":[2756,3391],"filename":"TemplateDoctor.js","lineno":94,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100004298","name":"TemplateDoctor","type":"MethodDefinition","paramnames":["templatePath","settings"]},"vars":{"":null}},"description":"Initializes a new instance of `Docma.TemplateDoctor`.","alias":"Docma.TemplateDoctor","kind":"class","params":[{"type":{"names":["String"]},"description":"Path of the template to be diagnosed.","name":"templatePath"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":"{}","description":"Diagnose settings.","name":"settings"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether not to log\n diagnostics information to console.","name":"settings.quiet"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"Whether\n to stop on first failure.","name":"settings.stopOnFirstFailure"}],"name":"TemplateDoctor","longname":"Docma.TemplateDoctor","memberof":"Docma","scope":"static","$longname":"Docma.TemplateDoctor","$kind":"constructor","$docmaLink":"api/#Docma.TemplateDoctor"}},{"comment":"/**\n * Initializes a new instance of `Docma.Template`.\n * @hideconstructor\n *\n * @param {Object} params - Template parameters.\n * @param {Object} params.modulePath - Resolved path of the template\n * module.\n * @param {Object} params.buildConfig - Docma build configuration (that\n * also includes template configuration).\n * @param {String} params.docmaVersion - Current Docma version.\n * @param {Function} params.fnLog - Log function to be used within the\n * template module.\n */","meta":{"range":[2614,3982],"filename":"Template.js","lineno":79,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib","code":{"id":"astnode100003503","name":"Template","type":"MethodDefinition","paramnames":["params"]},"vars":{"":null}},"description":"Initializes a new instance of `Docma.Template`.","hideconstructor":true,"params":[{"type":{"names":["Object"]},"description":"Template parameters.","name":"params"},{"type":{"names":["Object"]},"description":"Resolved path of the template\n module.","name":"params.modulePath"},{"type":{"names":["Object"]},"description":"Docma build configuration (that\n also includes template configuration).","name":"params.buildConfig"},{"type":{"names":["String"]},"description":"Current Docma version.","name":"params.docmaVersion"},{"type":{"names":["function"]},"description":"Log function to be used within the\n template module.","name":"params.fnLog"}],"name":"Template","longname":"Template","kind":"class","scope":"global","$longname":"Template","$kind":"constructor","$docmaLink":"api/#Template","$hide":true}],"symbols":["Docma","Docma#build","Docma~BuildConfiguration","Docma.create","Docma.Debug","Docma.RouteType","Docma.RoutingMethod","Docma.ServerType","Docma.Template","Docma.Template#author","Docma.Template#buildConfig","Docma.Template#debug","Docma.Template#defaultOptions","Docma.Template#description","Docma.Template#dirname","Docma.Template#docmaVersion","Docma.Template#getDestPath","Docma.Template#getSrcPath","Docma.Template#ignore","Docma.Template#license","Docma.Template#log","Docma.Template#mainHTML","Docma.Template#name","Docma.Template#options","Docma.Template#path","Docma.Template#pkg","Docma.Template#postBuild","Docma.Template#preBuild","Docma.Template#supportedDocmaVersion","Docma.Template#templateDir","Docma.Template#version","Docma.TemplateDoctor","Docma.TemplateDoctor#diagnose","Docma.TemplateDoctor#diagnostics","Docma.TemplateDoctor#pkg","Docma.TemplateDoctor#reset","Docma.TemplateDoctor#settings","Docma.TemplateDoctor#template","Docma.TemplateDoctor#templateName","Template"]},"web":{"documentation":[{"comment":"/**\n * Docma (web) core.\n *\n * When you build the documentation with a template, `docma-web.js` will be\n * generated (and linked in the main HTML); which is the core engine for the\n * documentation web app. This will include everything the app needs such as\n * the documentation data, compiled partials, dustjs engine, etc...\n *\n * An instance of this object is globally accessible within the generated SPA\n * as docma. Note that the size of the `docma-web.js` script depends primarily\n * on the generated documentation data.
\n *\n * @class\n * @name DocmaWeb\n * @hideconstructor\n * @emits DocmaWeb~event:ready\n * @emits DocmaWeb~event:render\n * @emits DocmaWeb~event:route\n * @emits DocmaWeb~event:navigate\n */","meta":{"filename":"DocmaWeb.js","lineno":17,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Docma (web) core.\n\n When you build the documentation with a template, `docma-web.js` will be\n generated (and linked in the main HTML); which is the core engine for the\n documentation web app. This will include everything the app needs such as\n the documentation data, compiled partials, dustjs engine, etc...\n\n An instance of this object is globally accessible within the generated SPA\n as docma. Note that the size of the `docma-web.js` script depends primarily\n on the generated documentation data.
","kind":"class","name":"DocmaWeb","hideconstructor":true,"fires":["DocmaWeb~event:ready","DocmaWeb~event:render","DocmaWeb~event:route","DocmaWeb~event:navigate"],"longname":"DocmaWeb","scope":"global","$longname":"DocmaWeb","$kind":"class","$docmaLink":"api/web/#DocmaWeb","$members":[{"comment":"/**\n * Adds a new Dust filter.\n * @chainable\n * @see {@link templates/filters/|Existing Docma (Dust) filters}\n * @see {@link https://www.dustjs.com/docs/filter-api|Dust Filter API}\n *\n * @param {String} name - Name of the filter to be added.\n * @param {Function} fn - Filter function.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n * @throws {Error} - If a filter with the given name already exists.\n */","meta":{"range":[23763,23970],"filename":"DocmaWeb.js","lineno":711,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000990","name":"DocmaWeb.prototype.addFilter","type":"FunctionExpression","paramnames":["name","fn"]},"vars":{"dust.filters[undefined]":"dust.filters[undefined]"}},"description":"Adds a new Dust filter.","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"see":["{@link templates/filters/|Existing Docma (Dust) filters}","{@link https://www.dustjs.com/docs/filter-api|Dust Filter API}"],"params":[{"type":{"names":["String"]},"description":"Name of the filter to be added.","name":"name"},{"type":{"names":["function"]},"description":"Filter function.","name":"fn"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"exceptions":[{"type":{"names":["Error"]},"description":"- If a filter with the given name already exists."}],"name":"addFilter","longname":"DocmaWeb#addFilter","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#addFilter","$kind":"method","$docmaLink":"api/web/#DocmaWeb#addFilter"},{"comment":"/**\n *\tHash-map of JSDoc documentation outputs.\n *\tEach key is the name of an API (formed by grouped Javascript files).\n *\te.g. `docma.apis[\"some-api\"]`\n *\n * Unnamed documentation data (consisting of ungrouped Javascript files) can be\n * accessed via `docma.apis._def_`.\n *\n *\tEach value is an `Object` with the following signature:\n *\t`{ documentation:Array, symbols:Array }`. `documentation` is the actual\n *\tJSDoc data, and `symbols` is a flat array of symbol names.\n *\n * See {@link api/#Docma~BuildConfiguration|build configuration} for more\n * details on how Javascript files can be grouped (and named) to form separate\n * API documentations and SPA routes.
\n *\n * @name DocmaWeb#apis\n * @type {Object}\n *\n * @example Programmatic access to documentation data \n * // output ungrouped (unnamed) API documentation data\n * console.log(docma.apis._def_.documentation);\n * console.log(docma.apis._def_.symbols); // flat list of symbol names\n * // output one of the grouped (named) API documentation data\n * console.log(docma.apis['my-scondary-api'].documentation);\n *\n * @example Usage in a Dust partial \n * \n * {#documentation}\n * {longname}
\n * {description}
\n *
\n * {/documentation}\n */","meta":{"filename":"DocmaWeb.js","lineno":79,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Hash-map of JSDoc documentation outputs.\n\tEach key is the name of an API (formed by grouped Javascript files).\n\te.g. `docma.apis[\"some-api\"]`\n\n Unnamed documentation data (consisting of ungrouped Javascript files) can be\n accessed via `docma.apis._def_`.\n\n\tEach value is an `Object` with the following signature:\n\t`{ documentation:Array, symbols:Array }`. `documentation` is the actual\n\tJSDoc data, and `symbols` is a flat array of symbol names.\n\n See {@link api/#Docma~BuildConfiguration|build configuration} for more\n details on how Javascript files can be grouped (and named) to form separate\n API documentations and SPA routes.
","name":"apis","type":{"names":["Object"]},"examples":["Programmatic access to documentation data \n // output ungrouped (unnamed) API documentation data\n console.log(docma.apis._def_.documentation);\n console.log(docma.apis._def_.symbols); // flat list of symbol names\n // output one of the grouped (named) API documentation data\n console.log(docma.apis['my-scondary-api'].documentation);\n\n ","Usage in a Dust partial \n \n {#documentation}\n {longname}
\n {description}
\n
\n {/documentation}"],"memberof":"DocmaWeb","longname":"DocmaWeb#apis","scope":"instance","kind":"member","$longname":"DocmaWeb#apis","$kind":"property","$docmaLink":"api/web/#DocmaWeb#apis"},{"comment":"/**\n * Provides configuration data of the generated SPA, which is originally set\n * at build-time, by the user.\n * See {@link api/#Docma~BuildConfiguration|build configuration} for more\n * details on how these settings take affect.\n * @name DocmaWeb#app\n * @type {Object}\n *\n * @property {String} title\n * Document title for the main file of the generated app.\n * (Value of the `<title/>` tag.)\n * @property {Array} meta\n * Array of arbitrary objects set for main document meta (tags).\n * @property {String} base\n * Base path of the generated web app.\n * @property {String} entrance\n * Name of the initial content displayed, when the web app is first\n * loaded.\n * @property {String|Object} routing\n * Routing settings for the generated SPA.\n * @property {String} server\n * Server/host type of the generated SPA.\n */","meta":{"filename":"DocmaWeb.js","lineno":49,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Provides configuration data of the generated SPA, which is originally set\n at build-time, by the user.\n See {@link api/#Docma~BuildConfiguration|build configuration} for more\n details on how these settings take affect.","name":"app","type":{"names":["Object"]},"properties":[{"type":{"names":["String"]},"description":"Base path of the generated web app.","name":"base"},{"type":{"names":["String"]},"description":"Name of the initial content displayed, when the web app is first\n loaded.","name":"entrance"},{"type":{"names":["Array"]},"description":"Array of arbitrary objects set for main document meta (tags).","name":"meta"},{"type":{"names":["String","Object"]},"description":"Routing settings for the generated SPA.","name":"routing"},{"type":{"names":["String"]},"description":"Server/host type of the generated SPA.","name":"server"},{"type":{"names":["String"]},"description":"Document title for the main file of the generated app.\n (Value of the `<title/>` tag.)","name":"title"}],"memberof":"DocmaWeb","longname":"DocmaWeb#app","scope":"instance","kind":"member","$longname":"DocmaWeb#app","$kind":"property","$docmaLink":"api/web/#DocmaWeb#app"},{"comment":"/**\n * Creates a SPA route information object for the given route name and type.\n *\n * @param {String} name\n * Name of the route.\n * @param {String} type\n * Type of the SPA route. See {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`}\n * enumeration for possible values.\n *\n * @returns {DocmaWeb.Route} - Route instance.\n */","meta":{"range":[24966,25073],"filename":"DocmaWeb.js","lineno":754,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001064","name":"DocmaWeb.prototype.createRoute","type":"FunctionExpression","paramnames":["name","type"]}},"description":"Creates a SPA route information object for the given route name and type.","params":[{"type":{"names":["String"]},"description":"Name of the route.","name":"name"},{"type":{"names":["String"]},"description":"Type of the SPA route. See {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`}\n enumeration for possible values.","name":"type"}],"returns":[{"type":{"names":["DocmaWeb.Route"]},"description":"- Route instance."}],"name":"createRoute","longname":"DocmaWeb#createRoute","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#createRoute","$kind":"method","$docmaLink":"api/web/#DocmaWeb#createRoute"},{"comment":"/**\n * Gets the route information for the current rendered content being\n * displayed.\n *\n * @name DocmaWeb#currentRoute\n * @type {DocmaWeb.Route}\n * @readonly\n *\n * @property {String} type\n * Type of the current route. If a generated JSDoc API\n * documentation is being displayed, this is set to `\"api\"`.\n * If any other HTML content (such as a converted markdown) is\n * being displayed; this is set to `\"content\"`.\n * @property {String} name\n * Name of the current route. For `api` routes, this is the name\n * of the grouped JS files parsed. If no name is given, this is\n * set to `\"_def_\"` by default. For `content` routes, this is\n * either the custom name given at build-time or, by default; the\n * name of the generated HTML file; lower-cased, without the\n * extension. e.g. `\"README.md\"` will have the route name\n * `\"readme\"` after the build.\n * @property {String} path\n * Path of the current route.\n */","meta":{"filename":"DocmaWeb.js","lineno":257,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the route information for the current rendered content being\n displayed.","name":"currentRoute","type":{"names":["DocmaWeb.Route"]},"readonly":true,"properties":[{"type":{"names":["String"]},"description":"Name of the current route. For `api` routes, this is the name\n of the grouped JS files parsed. If no name is given, this is\n set to `\"_def_\"` by default. For `content` routes, this is\n either the custom name given at build-time or, by default; the\n name of the generated HTML file; lower-cased, without the\n extension. e.g. `\"README.md\"` will have the route name\n `\"readme\"` after the build.","name":"name"},{"type":{"names":["String"]},"description":"Path of the current route.","name":"path"},{"type":{"names":["String"]},"description":"Type of the current route. If a generated JSDoc API\n documentation is being displayed, this is set to `\"api\"`.\n If any other HTML content (such as a converted markdown) is\n being displayed; this is set to `\"content\"`.","name":"type"}],"memberof":"DocmaWeb","longname":"DocmaWeb#currentRoute","scope":"instance","kind":"member","$longname":"DocmaWeb#currentRoute","$kind":"property","$docmaLink":"api/web/#DocmaWeb#currentRoute"},{"comment":"/**\n *\tJSDoc documentation data for the current API route.\n *\tIf current route is not an API route, this will be `null`.\n *\n * See {@link api/#Docma~BuildConfiguration|build configuration} for more\n * details on how Javascript files can be grouped (and named) to form\n * separate API documentations and SPA routes.
\n *\n * @name DocmaWeb#documentation\n * @type {Array}\n *\n * @example Output current API documentation data \n * if (docma.currentRoute.type === 'api') {\n * \tconsole.log(docma.documentation);\n * }\n *\n * @example Usage in (Dust) partial \n * {#documentation}\n * {longname}
\n * {description}
\n *
\n * {/documentation}\n */","meta":{"filename":"DocmaWeb.js","lineno":288,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"JSDoc documentation data for the current API route.\n\tIf current route is not an API route, this will be `null`.\n\n See {@link api/#Docma~BuildConfiguration|build configuration} for more\n details on how Javascript files can be grouped (and named) to form\n separate API documentations and SPA routes.
","name":"documentation","type":{"names":["Array"]},"examples":["Output current API documentation data \n if (docma.currentRoute.type === 'api') {\n \tconsole.log(docma.documentation);\n }\n\n ","Usage in (Dust) partial \n {#documentation}\n {longname}
\n {description}
\n
\n {/documentation}"],"memberof":"DocmaWeb","longname":"DocmaWeb#documentation","scope":"instance","kind":"member","$longname":"DocmaWeb#documentation","$kind":"property","$docmaLink":"api/web/#DocmaWeb#documentation"},{"comment":"/**\n * Outputs an error log to the browser console. (Unlike `console.error()`) this\n * method respects `debug` option of Docma build configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[19634,19759],"filename":"DocmaWeb.js","lineno":580,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000691","name":"DocmaWeb.prototype.error","type":"FunctionExpression","paramnames":[]}},"description":"Outputs an error log to the browser console. (Unlike `console.error()`) this\n method respects `debug` option of Docma build configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"error","longname":"DocmaWeb#error","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#error","$kind":"method","$docmaLink":"api/web/#DocmaWeb#error"},{"comment":"/**\n * Docma SPA events enumeration.\n * @enum {String}\n */","meta":{"range":[15063,15610],"filename":"DocmaWeb.js","lineno":419,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000477","name":"DocmaWeb.Event","type":"ObjectExpression","value":"{\"Ready\":\"ready\",\"Render\":\"render\",\"Route\":\"route\",\"Navigate\":\"navigate\"}","paramnames":[]}},"description":"Docma SPA events enumeration.","kind":"member","isEnum":true,"type":{"names":["String"]},"name":"Event","longname":"DocmaWeb.Event","memberof":"DocmaWeb","scope":"static","properties":[{"comment":"/**\n * Emitted either when the route is changed or navigated to a\n * bookmark (i.e. hashchange).\n * @type {String}\n */","meta":{"range":[15587,15607],"filename":"DocmaWeb.js","lineno":440,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000488","name":"Navigate","type":"Literal","value":"navigate"}},"description":"Emitted either when the route is changed or navigated to a\n bookmark (i.e. hashchange).","type":{"names":["String"]},"name":"Navigate","longname":"DocmaWeb.Event.Navigate","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"navigate"},{"comment":"/**\n * Emitted when Docma is ready and the initial content is rendered.\n * @type {String}\n */","meta":{"range":[15198,15212],"filename":"DocmaWeb.js","lineno":424,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000482","name":"Ready","type":"Literal","value":"ready"}},"description":"Emitted when Docma is ready and the initial content is rendered.","type":{"names":["String"]},"name":"Ready","longname":"DocmaWeb.Event.Ready","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"ready"},{"comment":"/**\n * Emitted when page content (a Dust partial) is rendered.\n * @type {String}\n */","meta":{"range":[15321,15337],"filename":"DocmaWeb.js","lineno":429,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000484","name":"Render","type":"Literal","value":"render"}},"description":"Emitted when page content (a Dust partial) is rendered.","type":{"names":["String"]},"name":"Render","longname":"DocmaWeb.Event.Render","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"render"},{"comment":"/**\n * Emitted when SPA route is changed.\n * @type {String}\n */","meta":{"range":[15425,15439],"filename":"DocmaWeb.js","lineno":434,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000486","name":"Route","type":"Literal","value":"route"}},"description":"Emitted when SPA route is changed.","type":{"names":["String"]},"name":"Route","longname":"DocmaWeb.Event.Route","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"route"}],"$longname":"DocmaWeb.Event","$kind":"enum","$docmaLink":"api/web/#DocmaWeb.Event","$members":[{"comment":"/**\n * Emitted either when the route is changed or navigated to a\n * bookmark (i.e. hashchange).\n * @type {String}\n */","meta":{"range":[15587,15607],"filename":"DocmaWeb.js","lineno":440,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000488","name":"Navigate","type":"Literal","value":"navigate"}},"description":"Emitted either when the route is changed or navigated to a\n bookmark (i.e. hashchange).","type":{"names":["String"]},"name":"Navigate","longname":"DocmaWeb.Event.Navigate","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"navigate","$longname":"DocmaWeb.Event.Navigate","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Navigate"},{"comment":"/**\n * Emitted when Docma is ready and the initial content is rendered.\n * @type {String}\n */","meta":{"range":[15198,15212],"filename":"DocmaWeb.js","lineno":424,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000482","name":"Ready","type":"Literal","value":"ready"}},"description":"Emitted when Docma is ready and the initial content is rendered.","type":{"names":["String"]},"name":"Ready","longname":"DocmaWeb.Event.Ready","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"ready","$longname":"DocmaWeb.Event.Ready","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Ready"},{"comment":"/**\n * Emitted when page content (a Dust partial) is rendered.\n * @type {String}\n */","meta":{"range":[15321,15337],"filename":"DocmaWeb.js","lineno":429,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000484","name":"Render","type":"Literal","value":"render"}},"description":"Emitted when page content (a Dust partial) is rendered.","type":{"names":["String"]},"name":"Render","longname":"DocmaWeb.Event.Render","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"render","$longname":"DocmaWeb.Event.Render","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Render"},{"comment":"/**\n * Emitted when SPA route is changed.\n * @type {String}\n */","meta":{"range":[15425,15439],"filename":"DocmaWeb.js","lineno":434,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000486","name":"Route","type":"Literal","value":"route"}},"description":"Emitted when SPA route is changed.","type":{"names":["String"]},"name":"Route","longname":"DocmaWeb.Event.Route","kind":"member","memberof":"DocmaWeb.Event","scope":"static","defaultvalue":"route","$longname":"DocmaWeb.Event.Route","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Event.Route"}]},{"comment":"/**\n * Fired either when the route is changed or navigated to a bookmark\n * (i.e. on hash-change). If the route does not exist (404), `currentRoute`\n * will be `null`.\n *\n * @event DocmaWeb~event:navigate\n * @type {DocmaWeb.Route}\n *\n * @example\n * docma.on('navigate', function (currentRoute) {\n * if (currentRoute) {\n * // do stuff...\n * }\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":399,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Fired either when the route is changed or navigated to a bookmark\n (i.e. on hash-change). If the route does not exist (404), `currentRoute`\n will be `null`.","kind":"event","name":"event:navigate","type":{"names":["DocmaWeb.Route"]},"examples":["docma.on('navigate', function (currentRoute) {\n if (currentRoute) {\n // do stuff...\n }\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:navigate","scope":"inner","$longname":"DocmaWeb~event:navigate","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:navigate"},{"comment":"/**\n * Fired when Docma is ready and the initial content is rendered.\n * This is only fired once.\n *\n * @event DocmaWeb~event:ready\n *\n * @example\n * docma.once('ready', function () {\n * // do stuff...\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":355,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Fired when Docma is ready and the initial content is rendered.\n This is only fired once.","kind":"event","name":"event:ready","examples":["docma.once('ready', function () {\n // do stuff...\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:ready","scope":"inner","$longname":"DocmaWeb~event:ready","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:ready"},{"comment":"/**\n * Fired when page content (a Dust partial) is rendered. The emitted obeject is\n * `currentRoute`. If the route does not exist (404), `currentRoute` will be\n * `null`. This is fired after the `route` event.\n *\n * @event DocmaWeb~event:render\n * @type {DocmaWeb.Route}\n *\n * @example\n * docma.on('render', function (currentRoute) {\n * if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n * // do stuff...\n * }\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":367,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Fired when page content (a Dust partial) is rendered. The emitted obeject is\n `currentRoute`. If the route does not exist (404), `currentRoute` will be\n `null`. This is fired after the `route` event.","kind":"event","name":"event:render","type":{"names":["DocmaWeb.Route"]},"examples":["docma.on('render', function (currentRoute) {\n if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n // do stuff...\n }\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:render","scope":"inner","$longname":"DocmaWeb~event:render","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:render"},{"comment":"/**\n * Fired when SPA route is changed. The emitted obeject is `currentRoute`. If\n * the route does not exist (404), `currentRoute` will be `null`. This is fired\n * before the `render` event.\n *\n * @event DocmaWeb~event:route\n * @type {DocmaWeb.Route}\n *\n * @example\n * docma.on('route', function (currentRoute) {\n * if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n * // do stuff...\n * }\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":383,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Fired when SPA route is changed. The emitted obeject is `currentRoute`. If\n the route does not exist (404), `currentRoute` will be `null`. This is fired\n before the `render` event.","kind":"event","name":"event:route","type":{"names":["DocmaWeb.Route"]},"examples":["docma.on('route', function (currentRoute) {\n if (currentRoute && currentRoute.type === docma.Route.Type.API) {\n // do stuff...\n }\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb~event:route","scope":"inner","$longname":"DocmaWeb~event:route","$kind":"event","$docmaLink":"api/web/#DocmaWeb~event:route"},{"comment":"/**\n * Asynchronously fetches (text) content from the given URL via an\n * `XmlHttpRequest`. Note that the URL has to be in the same-origin, for\n * this to work.\n *\n * @param {String} url\n * URL to be fetched.\n * @param {Function} callback\n * Function to be executed when the content is fetched; with the\n * following signature: `function (status, responseText) { .. }`\n */","meta":{"range":[28420,28850],"filename":"DocmaWeb.js","lineno":865,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001374","name":"DocmaWeb.prototype.fetch","type":"FunctionExpression","paramnames":["url","callback"]},"vars":{"xhr":"DocmaWeb#fetch~xhr","self":"DocmaWeb#fetch~self","xhr.onreadystatechange":"DocmaWeb#fetch~xhr.onreadystatechange","":null}},"description":"Asynchronously fetches (text) content from the given URL via an\n `XmlHttpRequest`. Note that the URL has to be in the same-origin, for\n this to work.","params":[{"type":{"names":["String"]},"description":"URL to be fetched.","name":"url"},{"type":{"names":["function"]},"description":"Function to be executed when the content is fetched; with the\n following signature: `function (status, responseText) { .. }`","name":"callback"}],"name":"fetch","longname":"DocmaWeb#fetch","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#fetch","$kind":"method","$docmaLink":"api/web/#DocmaWeb#fetch"},{"comment":"/**\n * Checks whether a Dust filter with the given name already exists.\n * @param {String} name - Name of the filter to be checked.\n * @returns {Boolean} -\n */","meta":{"range":[24421,24527],"filename":"DocmaWeb.js","lineno":735,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001045","name":"DocmaWeb.prototype.filterExists","type":"FunctionExpression","paramnames":["name"]}},"description":"Checks whether a Dust filter with the given name already exists.","params":[{"type":{"names":["String"]},"description":"Name of the filter to be checked.","name":"name"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"filterExists","longname":"DocmaWeb#filterExists","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#filterExists","$kind":"method","$docmaLink":"api/web/#DocmaWeb#filterExists"},{"comment":"/**\n * Gets Docma content DOM element that the HTML content will be loaded\n * into. This should be called for `docma-content` partial.\n *\n * @returns {HTMLElement} - Docma content DOM element.\n */","meta":{"range":[20467,21090],"filename":"DocmaWeb.js","lineno":611,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000764","name":"DocmaWeb.prototype.getContentElem","type":"FunctionExpression","paramnames":[]},"vars":{"dContent":"DocmaWeb#getContentElem~dContent"}},"description":"Gets Docma content DOM element that the HTML content will be loaded\n into. This should be called for `docma-content` partial.","returns":[{"type":{"names":["HTMLElement"]},"description":"- Docma content DOM element."}],"name":"getContentElem","longname":"DocmaWeb#getContentElem","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#getContentElem","$kind":"method","$docmaLink":"api/web/#DocmaWeb#getContentElem"},{"comment":"/**\n * Gets Docma main DOM element which the Dust templates will be rendered\n * into.\n *\n * @returns {HTMLElement} - Docma main DOM element.\n */","meta":{"range":[19990,20264],"filename":"DocmaWeb.js","lineno":595,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000717","name":"DocmaWeb.prototype.getDocmaElem","type":"FunctionExpression","paramnames":[]},"vars":{"docmaElem":"DocmaWeb#getDocmaElem~docmaElem"}},"description":"Gets Docma main DOM element which the Dust templates will be rendered\n into.","returns":[{"type":{"names":["HTMLElement"]},"description":"- Docma main DOM element."}],"name":"getDocmaElem","longname":"DocmaWeb#getDocmaElem","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#getDocmaElem","$kind":"method","$docmaLink":"api/web/#DocmaWeb#getDocmaElem"},{"comment":"/**\n * Outputs an informational log to the browser console. (Unlike\n * `console.info()`) this method respects `debug` option of Docma build\n * configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[18966,19089],"filename":"DocmaWeb.js","lineno":560,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000639","name":"DocmaWeb.prototype.info","type":"FunctionExpression","paramnames":[]}},"description":"Outputs an informational log to the browser console. (Unlike\n `console.info()`) this method respects `debug` option of Docma build\n configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"info","longname":"DocmaWeb#info","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#info","$kind":"method","$docmaLink":"api/web/#DocmaWeb#info"},{"comment":"/**\n * Loads the given HTML content into `docma-content` element. This is a\n * low-level method. Typically you would not need to use this.\n *\n * @param {String} html - Content to be loaded.\n */","meta":{"range":[21290,21837],"filename":"DocmaWeb.js","lineno":635,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000813","name":"DocmaWeb.prototype.loadContent","type":"FunctionExpression","paramnames":["html"]},"vars":{"dContent":"DocmaWeb#loadContent~dContent","dContent.innerHTML":"DocmaWeb#loadContent~dContent.innerHTML"}},"description":"Loads the given HTML content into `docma-content` element. This is a\n low-level method. Typically you would not need to use this.","params":[{"type":{"names":["String"]},"description":"Content to be loaded.","name":"html"}],"name":"loadContent","longname":"DocmaWeb#loadContent","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#loadContent","$kind":"method","$docmaLink":"api/web/#DocmaWeb#loadContent"},{"comment":"/**\n * Similar to `window.location` but with differences and additional\n * information.\n *\n * @name DocmaWeb#location\n * @type {Object}\n * @readonly\n *\n * @property {String} origin\n * Gets the protocol, hostname and port number of the current URL.\n * @property {String} host\n * Gets the hostname and port number of the current URL.\n * @property {String} hostname\n * Gets the domain name of the web host.\n * @property {String} protocol\n * Gets the web protocol used, without `:` suffix.\n * @property {String} href\n * Gets the href (URL) of the current location.\n * @property {String} entrance\n * Gets the application entrance route, which is set at Docma build-time.\n * @property {String} base\n * Gets the base path of the application URL, which is set at Docma build-time.\n * @property {String} fullpath\n * Gets the path and filename of the current URL.\n * @property {String} pathname\n * Gets the path and filename of the current URL, without the base.\n * @property {String} path\n * Gets the path, filename and query-string of the current URL, without the base.\n * @property {String} hash\n * Gets the anchor `#` of the current URL, without `#` prefix.\n * @property {String} query\n * Gets the querystring part of the current URL, without `?` prefix.\n * @property {Function} getQuery()\n * Gets the value of the given querystring parameter.\n */","meta":{"filename":"DocmaWeb.js","lineno":178,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Similar to `window.location` but with differences and additional\n information.","name":"location","type":{"names":["Object"]},"readonly":true,"properties":[{"type":{"names":["String"]},"description":"Gets the base path of the application URL, which is set at Docma build-time.","name":"base"},{"type":{"names":["String"]},"description":"Gets the application entrance route, which is set at Docma build-time.","name":"entrance"},{"type":{"names":["String"]},"description":"Gets the path and filename of the current URL.","name":"fullpath"},{"type":{"names":["function"]},"description":"Gets the value of the given querystring parameter.","name":"getQuery()"},{"type":{"names":["String"]},"description":"Gets the anchor `#` of the current URL, without `#` prefix.","name":"hash"},{"type":{"names":["String"]},"description":"Gets the hostname and port number of the current URL.","name":"host"},{"type":{"names":["String"]},"description":"Gets the domain name of the web host.","name":"hostname"},{"type":{"names":["String"]},"description":"Gets the href (URL) of the current location.","name":"href"},{"type":{"names":["String"]},"description":"Gets the protocol, hostname and port number of the current URL.","name":"origin"},{"type":{"names":["String"]},"description":"Gets the path, filename and query-string of the current URL, without the base.","name":"path"},{"type":{"names":["String"]},"description":"Gets the path and filename of the current URL, without the base.","name":"pathname"},{"type":{"names":["String"]},"description":"Gets the web protocol used, without `:` suffix.","name":"protocol"},{"type":{"names":["String"]},"description":"Gets the querystring part of the current URL, without `?` prefix.","name":"query"}],"memberof":"DocmaWeb","longname":"DocmaWeb#location","scope":"instance","kind":"member","$longname":"DocmaWeb#location","$kind":"property","$docmaLink":"api/web/#DocmaWeb#location"},{"comment":"/**\n * Outputs a general log to the browser console. (Unlike `console.log()`) this\n * method respects `debug` option of Docma build configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[18623,18744],"filename":"DocmaWeb.js","lineno":549,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000613","name":"DocmaWeb.prototype.log","type":"FunctionExpression","paramnames":[]}},"description":"Outputs a general log to the browser console. (Unlike `console.log()`) this\n method respects `debug` option of Docma build configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"log","longname":"DocmaWeb#log","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#log","$kind":"method","$docmaLink":"api/web/#DocmaWeb#log"},{"comment":"/**\n * Removes the given listener from the specified event.\n * @name DocmaWeb#off\n * @function\n * @alias DocmaWeb#removeListener\n * @chainable\n *\n * @param {String} eventName\n * Name of the event to remove the listener from.\n * See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.\n * @param {Function} listener\n * Function to be removed from the event.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n */","meta":{"filename":"DocmaWeb.js","lineno":504,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Removes the given listener from the specified event.","name":"off","kind":"function","alias":"DocmaWeb#removeListener","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the event to remove the listener from.\n See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.","name":"eventName"},{"type":{"names":["function"]},"description":"Function to be removed from the event.","name":"listener"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"memberof":"DocmaWeb","longname":"DocmaWeb#off","scope":"instance","$longname":"DocmaWeb#off","$kind":"method","$docmaLink":"api/web/#DocmaWeb#off"},{"comment":"/**\n * Adds a listener function to the specified event.\n * Note that the listener will not be added if it is a duplicate.\n * If the listener returns true then it will be removed after it is called.\n * @name DocmaWeb#on\n * @function\n * @alias DocmaWeb#addListener\n * @chainable\n *\n * @param {String} eventName\n * Name of the event to attach the listener to.\n * See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.\n * @param {Function} listener\n * Function to be called when the event is emitted. If the function\n * returns true then it will be removed after calling.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n *\n * @example\n * docma.on('render', function (currentRoute) {\n * \tif (!currentRoute) {\n * \t\tconsole.log('Not found!');\n * \t\treturn;\n * \t}\n * \tif (currentRoute.type === docma.Route.Type.API) {\n * \t\tconsole.log('This is an API route.')\n * \t}\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":443,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Adds a listener function to the specified event.\n Note that the listener will not be added if it is a duplicate.\n If the listener returns true then it will be removed after it is called.","name":"on","kind":"function","alias":"DocmaWeb#addListener","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the event to attach the listener to.\n See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.","name":"eventName"},{"type":{"names":["function"]},"description":"Function to be called when the event is emitted. If the function\n returns true then it will be removed after calling.","name":"listener"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"examples":["docma.on('render', function (currentRoute) {\n \tif (!currentRoute) {\n \t\tconsole.log('Not found!');\n \t\treturn;\n \t}\n \tif (currentRoute.type === docma.Route.Type.API) {\n \t\tconsole.log('This is an API route.')\n \t}\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb#on","scope":"instance","$longname":"DocmaWeb#on","$kind":"method","$docmaLink":"api/web/#DocmaWeb#on"},{"comment":"/**\n * Adds a listener that will be automatically removed after its first\n * execution.\n * @name DocmaWeb#once\n * @function\n * @alias DocmaWeb#addOnceListener\n * @chainable\n *\n * @param {String} eventName\n * Name of the event to attach the listener to.\n * See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.\n * @param {Function} listener\n * Function to be called when the event is emitted.\n *\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n *\n * @example\n * docma.once('ready', function () {\n * \tconsole.log('Docma is ready!');\n * });\n */","meta":{"filename":"DocmaWeb.js","lineno":478,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Adds a listener that will be automatically removed after its first\n execution.","name":"once","kind":"function","alias":"DocmaWeb#addOnceListener","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the event to attach the listener to.\n See {@link #DocmaWeb.Event|`DocmaWeb.Event`} enumeration.","name":"eventName"},{"type":{"names":["function"]},"description":"Function to be called when the event is emitted.","name":"listener"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"examples":["docma.once('ready', function () {\n \tconsole.log('Docma is ready!');\n });"],"memberof":"DocmaWeb","longname":"DocmaWeb#once","scope":"instance","$longname":"DocmaWeb#once","$kind":"method","$docmaLink":"api/web/#DocmaWeb#once"},{"comment":"/**\n * Removes an existing Dust filter.\n * @chainable\n * @param {String} name - Name of the filter to be removed.\n * @returns {DocmaWeb} - `DocmaWeb` instance for chaining.\n */","meta":{"range":[24154,24255],"filename":"DocmaWeb.js","lineno":725,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001026","name":"DocmaWeb.prototype.removeFilter","type":"FunctionExpression","paramnames":["name"]}},"description":"Removes an existing Dust filter.","tags":[{"originalTitle":"chainable","title":"chainable","text":""}],"params":[{"type":{"names":["String"]},"description":"Name of the filter to be removed.","name":"name"}],"returns":[{"type":{"names":["DocmaWeb"]},"description":"- `DocmaWeb` instance for chaining."}],"name":"removeFilter","longname":"DocmaWeb#removeFilter","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#removeFilter","$kind":"method","$docmaLink":"api/web/#DocmaWeb#removeFilter"},{"comment":"/**\n * Renders content into docma-main element, by the given route information.\n *\n * If the content is empty or `\"api\"`, we'll render the `docma-api` Dust\n * template. Otherwise, (e.g. `\"readme\"`) we'll render `docma-content` Dust\n * template, then fetch `content/readme.html` and load it in the `docma-main`\n * element.\n *\n * Note that rendering and the callback will be cancelled if the given\n * content is the latest content rendered.
\n *\n * @param {DocmaWeb.Route} routeInfo - Route information of the page to be\n * rendered.\n * @param {Function} [callback] - Function to be executed when the rendering is\n * complete. `function (httpStatus:Number) { .. }`\n * @returns {void}\n * @emits DocmaWeb~event:render\n */","meta":{"range":[29608,30949],"filename":"DocmaWeb.js","lineno":897,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001451","name":"DocmaWeb.prototype.render","type":"FunctionExpression","paramnames":["routeInfo","callback"]},"vars":{"this._.currentRoute":"DocmaWeb#render#_.currentRoute","isCbFn":"DocmaWeb#render~isCbFn","self":"DocmaWeb#render~self","":null}},"description":"Renders content into docma-main element, by the given route information.\n\n If the content is empty or `\"api\"`, we'll render the `docma-api` Dust\n template. Otherwise, (e.g. `\"readme\"`) we'll render `docma-content` Dust\n template, then fetch `content/readme.html` and load it in the `docma-main`\n element.\n\n Note that rendering and the callback will be cancelled if the given\n content is the latest content rendered.
","params":[{"type":{"names":["DocmaWeb.Route"]},"description":"Route information of the page to be\n rendered.","name":"routeInfo"},{"type":{"names":["function"]},"optional":true,"description":"Function to be executed when the rendering is\n complete. `function (httpStatus:Number) { .. }`","name":"callback"}],"returns":[{"type":{"names":["void"]}}],"fires":["DocmaWeb~event:render"],"name":"render","longname":"DocmaWeb#render","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#render","$kind":"method","$docmaLink":"api/web/#DocmaWeb#render"},{"comment":"/**\n * @classdesc Creates SPA route information object for the given route name\n * and type. You cannot directly construct an instance of this class via\n * `new` operator. Use {@link #DocmaWeb#createRoute|`DocmaWeb#createRoute`}\n * method instead.\n * @class\n * @hideconstructor\n *\n * @param {DocmaWeb} docma `DocmaWeb` instance.\n * @param {String} name Name of the route.\n * @param {String} type Type of the SPA route. See\n * {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n * for possible values.\n */","meta":{"range":[957,1763],"filename":"DocmaWeb.Route.js","lineno":28,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001638","name":"DocmaWeb.Route","type":"FunctionExpression","paramnames":["docma","name","type"]},"vars":{"this._docma":"DocmaWeb.Route#_docma","name":"DocmaWeb.Route~name","info":"DocmaWeb.Route~info"}},"classdesc":"Creates SPA route information object for the given route name\n and type. You cannot directly construct an instance of this class via\n `new` operator. Use {@link #DocmaWeb#createRoute|`DocmaWeb#createRoute`}\n method instead.","kind":"class","hideconstructor":true,"params":[{"type":{"names":["DocmaWeb"]},"description":"`DocmaWeb` instance.","name":"docma"},{"type":{"names":["String"]},"description":"Name of the route.","name":"name"},{"type":{"names":["String"]},"description":"Type of the SPA route. See\n {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n for possible values.","name":"type"}],"name":"Route","longname":"DocmaWeb.Route","memberof":"DocmaWeb","scope":"static","$longname":"DocmaWeb.Route","$kind":"class","$docmaLink":"api/web/#DocmaWeb.Route","$members":[{"comment":"/**\n * Applies the route to the application.\n * @emits DocmaWeb~event:route\n * @param {Function} [cb] - Callback function to be executed after route is\n * rendered.\n * @returns {DocmaWeb.Route} - The route instance for chaining.\n */","meta":{"range":[5988,6596],"filename":"DocmaWeb.Route.js","lineno":205,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001843","name":"DocmaWeb.Route.prototype.apply","type":"FunctionExpression","paramnames":["cb"]},"vars":{"this._docma._.documentation":"DocmaWeb.Route#_docma._.documentation","this._docma._.symbols":"DocmaWeb.Route#_docma._.symbols"}},"description":"Applies the route to the application.","fires":["DocmaWeb~event:route"],"params":[{"type":{"names":["function"]},"optional":true,"description":"Callback function to be executed after route is\n rendered.","name":"cb"}],"returns":[{"type":{"names":["DocmaWeb.Route"]},"description":"- The route instance for chaining."}],"name":"apply","longname":"DocmaWeb.Route#apply","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#apply","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#apply"},{"comment":"/**\n * Gets the path of the generated content (HTML) file.\n * If this is an API route, `contentPath` is `null`.\n * @name DocmaWeb.Route#contentPath\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":128,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the path of the generated content (HTML) file.\n If this is an API route, `contentPath` is `null`.","name":"contentPath","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#contentPath","kind":"member","$longname":"DocmaWeb.Route#contentPath","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#contentPath"},{"comment":"/**\n * Checks whether the route actually exists.\n * @returns {Boolean} -\n */","meta":{"range":[5070,5148],"filename":"DocmaWeb.Route.js","lineno":175,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001768","name":"DocmaWeb.Route.prototype.exists","type":"FunctionExpression","paramnames":[]}},"description":"Checks whether the route actually exists.","returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"exists","longname":"DocmaWeb.Route#exists","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#exists","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#exists"},{"comment":"/**\n * Gets the ID of the route. A route ID consists of the route type and the\n * name; delimited via a colon. e.g. `api:web`.\n * @name DocmaWeb.Route#id\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":120,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the ID of the route. A route ID consists of the route type and the\n name; delimited via a colon. e.g. `api:web`.","name":"id","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#id","kind":"member","$longname":"DocmaWeb.Route#id","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#id"},{"comment":"/**\n * Checks whether the route is currently being viewed.\n * @param {DocmaWeb.Route} routeInfo - Object to be checked.\n * @returns {Boolean} -\n */","meta":{"range":[5642,5747],"filename":"DocmaWeb.Route.js","lineno":194,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001822","name":"DocmaWeb.Route.prototype.isCurrent","type":"FunctionExpression","paramnames":[]}},"description":"Checks whether the route is currently being viewed.","params":[{"type":{"names":["DocmaWeb.Route"]},"description":"Object to be checked.","name":"routeInfo"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"isCurrent","longname":"DocmaWeb.Route#isCurrent","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#isCurrent","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#isCurrent"},{"comment":"/**\n * Checks whether the route is equal to the given route.\n * @param {DocmaWeb.Route} routeInfo - Route to be checked against.\n * @returns {Boolean} -\n */","meta":{"range":[5311,5488],"filename":"DocmaWeb.Route.js","lineno":184,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001785","name":"DocmaWeb.Route.prototype.isEqualTo","type":"FunctionExpression","paramnames":["routeInfo"]}},"description":"Checks whether the route is equal to the given route.","params":[{"type":{"names":["DocmaWeb.Route"]},"description":"Route to be checked against.","name":"routeInfo"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"name":"isEqualTo","longname":"DocmaWeb.Route#isEqualTo","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#isEqualTo","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#isEqualTo"},{"comment":"/**\n * Gets the name of the SPA route, which is either set by the user when\n * building the documentation; or auto-generated from the source file name.\n * @name DocmaWeb.Route#name\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":163,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the name of the SPA route, which is either set by the user when\n building the documentation; or auto-generated from the source file name.","name":"name","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#name","kind":"member","$longname":"DocmaWeb.Route#name","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#name"},{"comment":"/**\n * Gets the URL path of the SPA route. For example, if SPA route method is\n * `query`, the URL path for a route named `guide` will be `?content=guide`.\n * If routing method is `path` it will be `guide/`.\n * @name DocmaWeb.Route#path\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":136,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the URL path of the SPA route. For example, if SPA route method is\n `query`, the URL path for a route named `guide` will be `?content=guide`.\n If routing method is `path` it will be `guide/`.","name":"path","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#path","kind":"member","$longname":"DocmaWeb.Route#path","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#path"},{"comment":"/**\n * Gets the type of the source which this route is generated from. See\n * {@link #DocmaWeb.Route.SourceType|`DocmaWeb.Route.SourceType`} enumeration\n * for possible values.\n * @name DocmaWeb.Route#sourceType\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":154,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the type of the source which this route is generated from. See\n {@link #DocmaWeb.Route.SourceType|`DocmaWeb.Route.SourceType`} enumeration\n for possible values.","name":"sourceType","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#sourceType","kind":"member","$longname":"DocmaWeb.Route#sourceType","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#sourceType"},{"comment":"/**\n * Enumerates the source types that a SPA route is generated from.\n * @name DocmaWeb.Route.SourceType\n * @enum {String}\n * @static\n * @readonly\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":92,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Enumerates the source types that a SPA route is generated from.","name":"SourceType","kind":"member","isEnum":true,"type":{"names":["String"]},"scope":"static","readonly":true,"memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route.SourceType","$longname":"DocmaWeb.Route.SourceType","$kind":"enum","$docmaLink":"api/web/#DocmaWeb.Route.SourceType","$members":[{"comment":"/**\n * Indicates that the documentation route is generated from HTML\n * source.\n * @type {String}\n */","meta":{"range":[3620,3632],"filename":"DocmaWeb.Route.js","lineno":117,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001765","name":"HTML","type":"Literal","value":"html"}},"description":"Indicates that the documentation route is generated from HTML\n source.","type":{"names":["String"]},"name":"HTML","longname":"DocmaWeb.Route.SourceType.HTML","kind":"member","memberof":"DocmaWeb.Route.SourceType","scope":"static","$longname":"DocmaWeb.Route.SourceType.HTML","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.SourceType.HTML"},{"comment":"/**\n * Indicates that the documentation route is generated from Javascript\n * source.\n * @type {String}\n */","meta":{"range":[3338,3346],"filename":"DocmaWeb.Route.js","lineno":105,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001761","name":"JS","type":"Literal","value":"js"}},"description":"Indicates that the documentation route is generated from Javascript\n source.","type":{"names":["String"]},"name":"JS","longname":"DocmaWeb.Route.SourceType.JS","kind":"member","memberof":"DocmaWeb.Route.SourceType","scope":"static","$longname":"DocmaWeb.Route.SourceType.JS","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.SourceType.JS"},{"comment":"/**\n * Indicates that the documentation route is generated from markdown\n * source.\n * @type {String}\n */","meta":{"range":[3481,3489],"filename":"DocmaWeb.Route.js","lineno":111,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001763","name":"MD","type":"Literal","value":"md"}},"description":"Indicates that the documentation route is generated from markdown\n source.","type":{"names":["String"]},"name":"MD","longname":"DocmaWeb.Route.SourceType.MD","kind":"member","memberof":"DocmaWeb.Route.SourceType","scope":"static","$longname":"DocmaWeb.Route.SourceType.MD","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.SourceType.MD"}]},{"comment":"/**\n * Gets the string representation of the route.\n * @returns {String} -\n */","meta":{"range":[6680,6886],"filename":"DocmaWeb.Route.js","lineno":224,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001960","name":"DocmaWeb.Route.prototype.toString","type":"FunctionExpression","paramnames":[]},"vars":{"o":"DocmaWeb.Route#toString~o","":null}},"description":"Gets the string representation of the route.","returns":[{"type":{"names":["String"]},"description":"-"}],"name":"toString","longname":"DocmaWeb.Route#toString","kind":"function","memberof":"DocmaWeb.Route","scope":"instance","$longname":"DocmaWeb.Route#toString","$kind":"method","$docmaLink":"api/web/#DocmaWeb.Route#toString"},{"comment":"/**\n * Gets the type of the generated SPA route. See\n * {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n * for possible values.\n * @name DocmaWeb.Route#type\n * @type {String}\n * @instance\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":145,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the type of the generated SPA route. See\n {@link #DocmaWeb.Route.Type|`DocmaWeb.Route.Type`} enumeration\n for possible values.","name":"type","type":{"names":["String"]},"scope":"instance","memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route#type","kind":"member","$longname":"DocmaWeb.Route#type","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route#type"},{"comment":"/**\n * Enumerates the Docma SPA route types.\n * @name DocmaWeb.Route.Type\n * @enum {String}\n * @static\n * @readonly\n *\n * @example When `docma.app.routing.method` is `\"query\"` \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ ?api\n * api web ?api=web\n * content templates ?content=templates\n * content guide ?content=guide\n *\n * @example When `docma.app.routing.method` is `\"path\"` \n * type name path\n * ------- ---------------- --------------------------\n * api _def_ api/\n * api web api/web/\n * content templates templates/\n * content guide guide/\n *\n */","meta":{"filename":"DocmaWeb.Route.js","lineno":52,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Enumerates the Docma SPA route types.","name":"Type","kind":"member","isEnum":true,"type":{"names":["String"]},"scope":"static","readonly":true,"examples":["When `docma.app.routing.method` is `\"query\"` \n type name path\n ------- ---------------- --------------------------\n api _def_ ?api\n api web ?api=web\n content templates ?content=templates\n content guide ?content=guide\n\n ","When `docma.app.routing.method` is `\"path\"` \n type name path\n ------- ---------------- --------------------------\n api _def_ api/\n api web api/web/\n content templates templates/\n content guide guide/"],"memberof":"DocmaWeb.Route","longname":"DocmaWeb.Route.Type","$longname":"DocmaWeb.Route.Type","$kind":"enum","$docmaLink":"api/web/#DocmaWeb.Route.Type","$members":[{"comment":"/**\n * Indicates that the route is for API documentation content, generated\n * from one or more Javascript files.\n * @type {String}\n */","meta":{"range":[2756,2766],"filename":"DocmaWeb.Route.js","lineno":82,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001737","name":"API","type":"Literal","value":"api"}},"description":"Indicates that the route is for API documentation content, generated\n from one or more Javascript files.","type":{"names":["String"]},"name":"API","longname":"DocmaWeb.Route.Type.API","kind":"member","memberof":"DocmaWeb.Route.Type","scope":"static","$longname":"DocmaWeb.Route.Type.API","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.Type.API"},{"comment":"/**\n * Indicates that the route is for other content, such as parsed HTML\n * files or HTML files generated from markdown.\n * @type {String}\n */","meta":{"range":[2939,2957],"filename":"DocmaWeb.Route.js","lineno":88,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001739","name":"CONTENT","type":"Literal","value":"content"}},"description":"Indicates that the route is for other content, such as parsed HTML\n files or HTML files generated from markdown.","type":{"names":["String"]},"name":"CONTENT","longname":"DocmaWeb.Route.Type.CONTENT","kind":"member","memberof":"DocmaWeb.Route.Type","scope":"static","$longname":"DocmaWeb.Route.Type.CONTENT","$kind":"property","$docmaLink":"api/web/#DocmaWeb.Route.Type.CONTENT"}]}]},{"comment":"/**\n * Array of available SPA routes of the documentation.\n * This is created at build-time and defined via the `src` param of the\n * {@link api/#Docma~BuildConfiguration|build configuration}.\n *\n * @name DocmaWeb#routes\n * @type {Array}\n *\n * @see {@link #DocmaWeb.Route|`DocmaWeb.Route`}\n */","meta":{"filename":"DocmaWeb.js","lineno":123,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Array of available SPA routes of the documentation.\n This is created at build-time and defined via the `src` param of the\n {@link api/#Docma~BuildConfiguration|build configuration}.","name":"routes","type":{"names":["Array"]},"see":["{@link #DocmaWeb.Route|`DocmaWeb.Route`}"],"memberof":"DocmaWeb","longname":"DocmaWeb#routes","scope":"instance","kind":"member","$longname":"DocmaWeb#routes","$kind":"property","$docmaLink":"api/web/#DocmaWeb#routes"},{"comment":"/**\n *\tA flat array of JSDoc documentation symbol names. This is useful for\n *\tbuilding menus, etc... If current route is not an API route, this will\n *\tbe `null`.\n *\n * See {@link api/docma#Docma~BuildConfiguration|build configuration} for more\n * details on how Javascript files can be grouped (and named) to form\n * separate API documentations and SPA routes.
\n *\n * @name DocmaWeb#symbols\n * @type {Array}\n *\n * @example Usage in (Dust) partial \n * \n */","meta":{"filename":"DocmaWeb.js","lineno":318,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"A flat array of JSDoc documentation symbol names. This is useful for\n\tbuilding menus, etc... If current route is not an API route, this will\n\tbe `null`.\n\n See {@link api/docma#Docma~BuildConfiguration|build configuration} for more\n details on how Javascript files can be grouped (and named) to form\n separate API documentations and SPA routes.
","name":"symbols","type":{"names":["Array"]},"examples":["Usage in (Dust) partial \n "],"memberof":"DocmaWeb","longname":"DocmaWeb#symbols","scope":"instance","kind":"member","$longname":"DocmaWeb#symbols","$kind":"property","$docmaLink":"api/web/#DocmaWeb#symbols"},{"comment":"/**\n * Provides template specific configuration data.\n * This is also useful within the Dust partials of the Docma template.\n * @name DocmaWeb#template\n * @type {Object}\n *\n * @property {Object} options - Docma template options. Defined at build-time,\n * by the user.\n * @property {String} name\n * Name of the Docma template.\n * @property {String} version\n * Version of the Docma template.\n * @property {String} author\n * Author information for the Docma template.\n * @property {String} license\n * License information for the Docma template.\n * @property {String} mainHTML\n * Name of the main file of the template. i.e. `index.html`\n *\n * @example Usage in a Dust partial \n * \n * {?template.options.someOption}\n * Displayed if someOption is true.\n * {/template.options.someOption}\n * \n * \n */","meta":{"filename":"DocmaWeb.js","lineno":140,"columnno":4,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Provides template specific configuration data.\n This is also useful within the Dust partials of the Docma template.","name":"template","type":{"names":["Object"]},"properties":[{"type":{"names":["String"]},"description":"Author information for the Docma template.","name":"author"},{"type":{"names":["String"]},"description":"License information for the Docma template.","name":"license"},{"type":{"names":["String"]},"description":"Name of the main file of the template. i.e. `index.html`","name":"mainHTML"},{"type":{"names":["String"]},"description":"Name of the Docma template.","name":"name"},{"type":{"names":["Object"]},"description":"Docma template options. Defined at build-time,\n by the user.","name":"options"},{"type":{"names":["String"]},"description":"Version of the Docma template.","name":"version"}],"examples":["Usage in a Dust partial \n \n {?template.options.someOption}\n Displayed if someOption is true.\n {/template.options.someOption}\n \n "],"memberof":"DocmaWeb","longname":"DocmaWeb#template","scope":"instance","kind":"member","$longname":"DocmaWeb#template","$kind":"property","$docmaLink":"api/web/#DocmaWeb#template"},{"comment":"/**\n * Utilities for inspecting JSDoc documentation and symbols; and parsing\n * documentation data into proper HTML.\n * See {@link api/web/utils|`DocmaWeb.Utils` documentation}.\n * @type {Object}\n * @namespace\n */","meta":{"range":[31253,31275],"filename":"DocmaWeb.js","lineno":945,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100001627","name":"DocmaWeb.Utils","type":"Identifier","value":"Utils","paramnames":[]}},"description":"Utilities for inspecting JSDoc documentation and symbols; and parsing\n documentation data into proper HTML.\n See {@link api/web/utils|`DocmaWeb.Utils` documentation}.","type":{"names":["Object"]},"kind":"namespace","name":"Utils","longname":"DocmaWeb.Utils","memberof":"DocmaWeb","scope":"static","$longname":"DocmaWeb.Utils","$kind":"namespace","$docmaLink":"api/web/#DocmaWeb.Utils"},{"comment":"/**\n * Gets Docma version which the documentation is built with.\n * @name DocmaWeb#version\n * @type {String}\n */","meta":{"filename":"DocmaWeb.js","lineno":11,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets Docma version which the documentation is built with.","name":"version","type":{"names":["String"]},"memberof":"DocmaWeb","longname":"DocmaWeb#version","scope":"instance","kind":"member","$longname":"DocmaWeb#version","$kind":"property","$docmaLink":"api/web/#DocmaWeb#version"},{"comment":"/**\n * Outputs a warning log to the browser console. (Unlike `console.warn()`) this\n * method respects `debug` option of Docma build configuration.\n * @param {...*} [args=\"\"] - Arguments to be logged.\n */","meta":{"range":[19300,19423],"filename":"DocmaWeb.js","lineno":570,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{"id":"astnode100000665","name":"DocmaWeb.prototype.warn","type":"FunctionExpression","paramnames":[]}},"description":"Outputs a warning log to the browser console. (Unlike `console.warn()`) this\n method respects `debug` option of Docma build configuration.","params":[{"type":{"names":["*"]},"optional":true,"variable":true,"defaultvalue":"\"\"","description":"Arguments to be logged.","name":"args"}],"name":"warn","longname":"DocmaWeb#warn","kind":"function","memberof":"DocmaWeb","scope":"instance","$longname":"DocmaWeb#warn","$kind":"method","$docmaLink":"api/web/#DocmaWeb#warn"}]}],"symbols":["DocmaWeb","DocmaWeb#addFilter","DocmaWeb#apis","DocmaWeb#app","DocmaWeb#createRoute","DocmaWeb#currentRoute","DocmaWeb#documentation","DocmaWeb#error","DocmaWeb.Event","DocmaWeb~event:navigate","DocmaWeb~event:ready","DocmaWeb~event:render","DocmaWeb~event:route","DocmaWeb#fetch","DocmaWeb#filterExists","DocmaWeb#getContentElem","DocmaWeb#getDocmaElem","DocmaWeb#info","DocmaWeb#loadContent","DocmaWeb#location","DocmaWeb#log","DocmaWeb#off","DocmaWeb#on","DocmaWeb#once","DocmaWeb#removeFilter","DocmaWeb#render","DocmaWeb.Route","DocmaWeb.Route#apply","DocmaWeb.Route#contentPath","DocmaWeb.Route#exists","DocmaWeb.Route#id","DocmaWeb.Route#isCurrent","DocmaWeb.Route#isEqualTo","DocmaWeb.Route#name","DocmaWeb.Route#path","DocmaWeb.Route#sourceType","DocmaWeb.Route.SourceType","DocmaWeb.Route#toString","DocmaWeb.Route#type","DocmaWeb.Route.Type","DocmaWeb#routes","DocmaWeb#symbols","DocmaWeb#template","DocmaWeb.Utils","DocmaWeb#version","DocmaWeb#warn"]},"web/utils":{"documentation":[{"comment":"/**\n * Docma (web) core class.\n * See {@link api/web|documentation}.\n * @name DocmaWeb\n * @class\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":6,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Docma (web) core class.\n See {@link api/web|documentation}.","name":"DocmaWeb","kind":"class","longname":"DocmaWeb","scope":"global","$longname":"DocmaWeb","$kind":"class","$docmaLink":"api/web/utils/#DocmaWeb","$members":[{"comment":"/**\n * Utilities for inspecting JSDoc documentation and symbols; and parsing\n * documentation data into proper HTML.\n * @name DocmaWeb.Utils\n * @type {Object}\n * @namespace\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":18,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Utilities for inspecting JSDoc documentation and symbols; and parsing\n documentation data into proper HTML.","name":"Utils","type":{"names":["Object"]},"kind":"namespace","memberof":"DocmaWeb","longname":"DocmaWeb.Utils","scope":"static","$longname":"DocmaWeb.Utils","$kind":"namespace","$docmaLink":"api/web/utils/#DocmaWeb.Utils","$members":[{"comment":"/**\n * DOM utilities.\n * @name DocmaWeb.Utils.DOM\n * @namespace\n * @type {Object}\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1563,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"DOM utilities.","name":"DOM","kind":"namespace","type":{"names":["Object"]},"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.DOM","scope":"static","$longname":"DocmaWeb.Utils.DOM","$kind":"namespace","$docmaLink":"api/web/utils/#DocmaWeb.Utils.DOM","$members":[{"comment":"/**\n * Gets the offset coordinates of the given element, relative to document\n * body.\n * @name DocmaWeb.Utils.DOM.getOffset\n * @function\n * @static\n *\n * @param {HTMLElement} e - Target element.\n * @returns {Object|null} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1575,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the offset coordinates of the given element, relative to document\n body.","name":"getOffset","kind":"function","scope":"static","params":[{"type":{"names":["HTMLElement"]},"description":"Target element.","name":"e"}],"returns":[{"type":{"names":["Object","null"]},"description":"-"}],"memberof":"DocmaWeb.Utils.DOM","longname":"DocmaWeb.Utils.DOM.getOffset","$longname":"DocmaWeb.Utils.DOM.getOffset","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.DOM.getOffset"},{"comment":"/**\n * Scrolls the document to the given hash target.\n * @name DocmaWeb.Utils.DOM.scrollTo\n * @function\n * @static\n *\n * @param {String} [hash] - Bookmark target. If omitted, document is\n * scrolled to the top.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1599,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Scrolls the document to the given hash target.","name":"scrollTo","kind":"function","scope":"static","params":[{"type":{"names":["String"]},"optional":true,"description":"Bookmark target. If omitted, document is\n scrolled to the top.","name":"hash"}],"memberof":"DocmaWeb.Utils.DOM","longname":"DocmaWeb.Utils.DOM.scrollTo","$longname":"DocmaWeb.Utils.DOM.scrollTo","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.DOM.scrollTo"}]},{"comment":"/**\n * Gets code file information from the given symbol.\n * @name DocmaWeb.Utils.getCodeFileInfo\n * @function\n *\n * @param {Object} symbol - Target documentation symbol.\n * @returns {Object} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":946,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets code file information from the given symbol.","name":"getCodeFileInfo","kind":"function","params":[{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"}],"returns":[{"type":{"names":["Object"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getCodeFileInfo","scope":"static","$longname":"DocmaWeb.Utils.getCodeFileInfo","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getCodeFileInfo"},{"comment":"/**\n * Gets the code name of the given symbol.\n * @name DocmaWeb.Utils.getCodeName\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {String} - If no code name, falls back to long name.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":176,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the code name of the given symbol.","name":"getCodeName","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"- If no code name, falls back to long name."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getCodeName","scope":"static","$longname":"DocmaWeb.Utils.getCodeName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getCodeName"},{"comment":"/**\n * Gets HTML formatted, delimeted code tags.\n * @name DocmaWeb.Utils.getCodeTags\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Array} list - String list of values to be placed within code\n * tags.\n * @param {Object} [options] - Options.\n * @param {String} [options.delimeter=\",\"] - String delimeter.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1146,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets HTML formatted, delimeted code tags.","name":"getCodeTags","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Array"]},"description":"String list of values to be placed within code\n tags.","name":"list"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\",\"","description":"String delimeter.","name":"options.delimeter"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getCodeTags","scope":"static","$longname":"DocmaWeb.Utils.getCodeTags","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getCodeTags"},{"comment":"/**\n * Gets HTML formatted list of emitted events from the given list. Event\n * names items are wrapped with code tags. If multiple, formatted as an\n * HTML unordered list.\n * @name DocmaWeb.Utils.getEmittedEvents\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Array} list - List of emitted (fired) events.\n * @param {Object} [options] - Options.\n * @param {String} [options.delimeter=\", \"] - Events delimeter.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1243,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets HTML formatted list of emitted events from the given list. Event\n names items are wrapped with code tags. If multiple, formatted as an\n HTML unordered list.","name":"getEmittedEvents","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Array"]},"description":"List of emitted (fired) events.","name":"list"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\", \"","description":"Events delimeter.","name":"options.delimeter"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getEmittedEvents","scope":"static","$longname":"DocmaWeb.Utils.getEmittedEvents","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getEmittedEvents"},{"comment":"/**\n * Gets HTML formatted list of types from the given symbols list. Type\n * items are wrapped with code tags. If multiple, formatted as an HTML\n * unordered list.\n * @name DocmaWeb.Utils.getFormattedTypeList\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Array} list - List of symbols to be converted to formatted\n * string.\n * @param {Object} [options] - Format options.\n * @param {String} [options.delimeter=\"|\"] - Types delimeter.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n * @param {Boolean} [options.descriptions=true] - Whether to include descriptions.\n * @param {String} [options.descDelimeter=\" — \"] - Description delimiter.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1181,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets HTML formatted list of types from the given symbols list. Type\n items are wrapped with code tags. If multiple, formatted as an HTML\n unordered list.","name":"getFormattedTypeList","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Array"]},"description":"List of symbols to be converted to formatted\n string.","name":"list"},{"type":{"names":["Object"]},"optional":true,"description":"Format options.","name":"options"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\"|\"","description":"Types delimeter.","name":"options.delimeter"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":true,"description":"Whether to include descriptions.","name":"options.descriptions"},{"type":{"names":["String"]},"optional":true,"defaultvalue":"\" — \"","description":"Description delimiter.","name":"options.descDelimeter"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getFormattedTypeList","scope":"static","$longname":"DocmaWeb.Utils.getFormattedTypeList","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getFormattedTypeList"},{"comment":"/**\n * Builds a string of keywords from the given symbol.\n * This is useful for filter/search features of a template.\n * @name DocmaWeb.Utils.getKeywords\n * @function\n *\n * @param {Object} symbol - Target documentation symbol.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":906,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Builds a string of keywords from the given symbol.\n This is useful for filter/search features of a template.","name":"getKeywords","kind":"function","params":[{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getKeywords","scope":"static","$longname":"DocmaWeb.Utils.getKeywords","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getKeywords"},{"comment":"/**\n * Gets the number of levels for the given symbol or name. e.g.\n * `mylib.prop` has 2 levels.\n * @name DocmaWeb.Utils.getLevels\n * @function\n *\n * @param {Object|String} symbol - Documented symbol object or long name.\n * @returns {Number} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":232,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the number of levels for the given symbol or name. e.g.\n `mylib.prop` has 2 levels.","name":"getLevels","kind":"function","params":[{"type":{"names":["Object","String"]},"description":"Documented symbol object or long name.","name":"symbol"}],"returns":[{"type":{"names":["Number"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getLevels","scope":"static","$longname":"DocmaWeb.Utils.getLevels","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getLevels"},{"comment":"/**\n * Gets the original long name of the given symbol.\n * JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n * alias. This returns the correct long name.\n * @name DocmaWeb.Utils.getLongName\n * @function\n * @alias getFullName\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":138,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the original long name of the given symbol.\n JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n alias. This returns the correct long name.","name":"getLongName","kind":"function","alias":"getFullName","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getLongName","$longname":"DocmaWeb.Utils.getLongName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getLongName"},{"comment":"/**\n * Gets the short name of the given symbol.\n * JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n * alias. This returns the correct short name.\n * @name DocmaWeb.Utils.getName\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":119,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the short name of the given symbol.\n JSDoc overwrites the `longname` and `name` of the symbol, if it has an\n alias. This returns the correct short name.","name":"getName","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getName","scope":"static","$longname":"DocmaWeb.Utils.getName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getName"},{"comment":"/**\n * Gets the parent symbol object from the given symbol object or symbol's\n * name.\n * @name DocmaWeb.Utils.getParent\n * @function\n *\n * @param {Array|Object} docs - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object|String} symbol - Documented symbol object or long name.\n * @returns {String} - `null` if symbol has no parent.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":281,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the parent symbol object from the given symbol object or symbol's\n name.","name":"getParent","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docs"},{"type":{"names":["Object","String"]},"description":"Documented symbol object or long name.","name":"symbol"}],"returns":[{"type":{"names":["String"]},"description":"- `null` if symbol has no parent."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getParent","scope":"static","$longname":"DocmaWeb.Utils.getParent","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getParent"},{"comment":"/**\n * Gets the parent symbol name from the given symbol object or symbol's name\n * (notation). Note that, this will return the parent name even if the parent\n * symbol does not exist in the documentation. If there is no parent, returns\n * `\"\"` (empty string).\n * @name DocmaWeb.Utils.getParentName\n * @function\n *\n * @param {Object|String} symbol - Documented symbol object or long name.\n * @returns {Number} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":250,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the parent symbol name from the given symbol object or symbol's name\n (notation). Note that, this will return the parent name even if the parent\n symbol does not exist in the documentation. If there is no parent, returns\n `\"\"` (empty string).","name":"getParentName","kind":"function","params":[{"type":{"names":["Object","String"]},"description":"Documented symbol object or long name.","name":"symbol"}],"returns":[{"type":{"names":["Number"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getParentName","scope":"static","$longname":"DocmaWeb.Utils.getParentName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getParentName"},{"comment":"/**\n * Gets the return types of the symbol as a string (joined with pipes `|`).\n * @name DocmaWeb.Utils.getReturnTypes\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object} symbol - Target documentation symbol.\n * @param {Object} [options] - Options.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1107,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the return types of the symbol as a string (joined with pipes `|`).","name":"getReturnTypes","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getReturnTypes","scope":"static","$longname":"DocmaWeb.Utils.getReturnTypes","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getReturnTypes"},{"comment":"/**\n * Gets the first matching symbol by the given name.\n * @name DocmaWeb.Utils.getSymbolByName\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {String} name - Symbol name to be checked. Better, pass the\n * `longname` (or `$longname`). It will still find a short name but it'll\n * return the first occurence if there are multiple symbols with the same\n * short name. e.g. `create` is ambiguous but `Docma.create` is unique.\n *\n * @returns {Object} - Symbol object if found. Otherwise, returns `null`.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":188,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the first matching symbol by the given name.","name":"getSymbolByName","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["String"]},"description":"Symbol name to be checked. Better, pass the\n `longname` (or `$longname`). It will still find a short name but it'll\n return the first occurence if there are multiple symbols with the same\n short name. e.g. `create` is ambiguous but `Docma.create` is unique.","name":"name"}],"returns":[{"type":{"names":["Object"]},"description":"- Symbol object if found. Otherwise, returns `null`."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getSymbolByName","scope":"static","$longname":"DocmaWeb.Utils.getSymbolByName","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getSymbolByName"},{"comment":"/**\n * Gets Docma route link for the given symbol or symbol name.\n * @name DocmaWeb.Utils.getSymbolLink\n * @function\n * @static\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object|String} symbolOrName - Either the symbol itself or the\n * name of the symbol.\n *\n * @returns {String} - Empty string if symbol is not found.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":962,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets Docma route link for the given symbol or symbol name.","name":"getSymbolLink","kind":"function","scope":"static","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Object","String"]},"description":"Either the symbol itself or the\n name of the symbol.","name":"symbolOrName"}],"returns":[{"type":{"names":["String"]},"description":"- Empty string if symbol is not found."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getSymbolLink","$longname":"DocmaWeb.Utils.getSymbolLink","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getSymbolLink"},{"comment":"/**\n * Gets the types of the symbol as a string (joined with pipes `|`).\n * @name DocmaWeb.Utils.getTypes\n * @function\n *\n * @param {Array|Object} docsOrApis - Documentation array or APIs object\n * with signature `{ documentation:Array, symbols:Array }`.\n * @param {Object} symbol - Target documentation symbol.\n * @param {Object} [options] - Options.\n * @param {Boolean|String} [options.links=false] - Whether to add\n * HTML anchor links to output. Set to `\"internal\"` to link\n * internally (to Docma route with symbol hash, if found) or\n * `\"external\"` to link externally (to MDN URL if this is a\n * JS/Web-API built-in type/object) or `true` to try linking either\n * to an internal or external target, which ever is found.\n *\n * @returns {String} -\n *\n * @example\n * var symbol = { \"type\": { \"names\": [\"Number\", \"String\"] } };\n * DocmaWeb.Utils.getTypes(docs, symbol); // \"Number|String\"\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":1059,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the types of the symbol as a string (joined with pipes `|`).","name":"getTypes","kind":"function","params":[{"type":{"names":["Array","Object"]},"description":"Documentation array or APIs object\n with signature `{ documentation:Array, symbols:Array }`.","name":"docsOrApis"},{"type":{"names":["Object"]},"description":"Target documentation symbol.","name":"symbol"},{"type":{"names":["Object"]},"optional":true,"description":"Options.","name":"options"},{"type":{"names":["Boolean","String"]},"optional":true,"defaultvalue":false,"description":"Whether to add\n HTML anchor links to output. Set to `\"internal\"` to link\n internally (to Docma route with symbol hash, if found) or\n `\"external\"` to link externally (to MDN URL if this is a\n JS/Web-API built-in type/object) or `true` to try linking either\n to an internal or external target, which ever is found.","name":"options.links"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"examples":["var symbol = { \"type\": { \"names\": [\"Number\", \"String\"] } };\n DocmaWeb.Utils.getTypes(docs, symbol); // \"Number|String\""],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.getTypes","scope":"static","$longname":"DocmaWeb.Utils.getTypes","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.getTypes"},{"comment":"/**\n * Checks whether the given symbol has description.\n * @name DocmaWeb.Utils.hasDescription\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":711,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has description.","name":"hasDescription","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.hasDescription","scope":"static","$longname":"DocmaWeb.Utils.hasDescription","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.hasDescription"},{"comment":"/**\n * Checks whether the given symbol is a callback definition.\n * @name DocmaWeb.Utils.isCallback\n * @function\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":565,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a callback definition.","name":"isCallback","kind":"function","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isCallback","$longname":"DocmaWeb.Utils.isCallback","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isCallback"},{"comment":"/**\n * Checks whether the given symbol is a class.\n * @name DocmaWeb.Utils.isClass\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":365,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a class.","name":"isClass","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isClass","scope":"static","$longname":"DocmaWeb.Utils.isClass","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isClass"},{"comment":"/**\n * Checks whether the given symbol is marked as a constant.\n * @name DocmaWeb.Utils.isConstant\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":382,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is marked as a constant.","name":"isConstant","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isConstant","scope":"static","$longname":"DocmaWeb.Utils.isConstant","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isConstant"},{"comment":"/**\n * Checks whether the given symbol is a constructor.\n * @name DocmaWeb.Utils.isConstructor\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":394,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a constructor.","name":"isConstructor","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isConstructor","scope":"static","$longname":"DocmaWeb.Utils.isConstructor","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isConstructor"},{"comment":"/**\n * Checks whether the given symbol is deprecated.\n * @name DocmaWeb.Utils.isDeprecated\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":304,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is deprecated.","name":"isDeprecated","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isDeprecated","scope":"static","$longname":"DocmaWeb.Utils.isDeprecated","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isDeprecated"},{"comment":"/**\n * Checks whether the given symbol is an enumeration.\n * @name DocmaWeb.Utils.isEnum\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":584,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an enumeration.","name":"isEnum","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isEnum","scope":"static","$longname":"DocmaWeb.Utils.isEnum","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isEnum"},{"comment":"/**\n * Checks whether the given symbol is an event.\n * @name DocmaWeb.Utils.isEvent\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":596,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an event.","name":"isEvent","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isEvent","scope":"static","$longname":"DocmaWeb.Utils.isEvent","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isEvent"},{"comment":"/**\n * Checks whether the given symbol is defined outside of the current package.\n * @name DocmaWeb.Utils.isExternal\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":608,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is defined outside of the current package.","name":"isExternal","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isExternal","scope":"static","$longname":"DocmaWeb.Utils.isExternal","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isExternal"},{"comment":"/**\n * Checks whether the given symbol is a generator function.\n * @name DocmaWeb.Utils.isGenerator\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":620,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a generator function.","name":"isGenerator","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isGenerator","scope":"static","$longname":"DocmaWeb.Utils.isGenerator","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isGenerator"},{"comment":"/**\n * Checks whether the given symbol has global scope.\n * @name DocmaWeb.Utils.isGlobal\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":316,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has global scope.","name":"isGlobal","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isGlobal","scope":"static","$longname":"DocmaWeb.Utils.isGlobal","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isGlobal"},{"comment":"/**\n * Checks whether the given symbol has an inner scope.\n * @name DocmaWeb.Utils.isInner\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":429,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has an inner scope.","name":"isInner","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInner","scope":"static","$longname":"DocmaWeb.Utils.isInner","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInner"},{"comment":"/**\n * Checks whether the given symbol is an instance member.\n * @name DocmaWeb.Utils.isInstanceMember\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":441,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an instance member.","name":"isInstanceMember","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInstanceMember","scope":"static","$longname":"DocmaWeb.Utils.isInstanceMember","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInstanceMember"},{"comment":"/**\n * Checks whether the given symbol is an instance method.\n * @name DocmaWeb.Utils.isInstanceMethod\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":486,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an instance method.","name":"isInstanceMethod","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInstanceMethod","scope":"static","$longname":"DocmaWeb.Utils.isInstanceMethod","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInstanceMethod"},{"comment":"/**\n * Checks whether the given symbol is an instance property.\n * @name DocmaWeb.Utils.isInstanceProperty\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":522,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is an instance property.","name":"isInstanceProperty","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInstanceProperty","scope":"static","$longname":"DocmaWeb.Utils.isInstanceProperty","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInstanceProperty"},{"comment":"/**\n * Checks whether the given symbol is marked as an interface that other symbols\n * can implement.\n * @name DocmaWeb.Utils.isInterface\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":453,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is marked as an interface that other symbols\n can implement.","name":"isInterface","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isInterface","scope":"static","$longname":"DocmaWeb.Utils.isInterface","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isInterface"},{"comment":"/**\n * Checks whether the given symbol is a method (function).\n * @name DocmaWeb.Utils.isMethod\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":466,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a method (function).","name":"isMethod","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isMethod","scope":"static","$longname":"DocmaWeb.Utils.isMethod","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isMethod"},{"comment":"/**\n * Checks whether the given symbol is marked as a mixin (is intended to be\n * added to other objects).\n * @name DocmaWeb.Utils.isMixin\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":352,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is marked as a mixin (is intended to be\n added to other objects).","name":"isMixin","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isMixin","scope":"static","$longname":"DocmaWeb.Utils.isMixin","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isMixin"},{"comment":"/**\n * Checks whether the given symbol is a module.\n * @name DocmaWeb.Utils.isModule\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":340,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a module.","name":"isModule","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isModule","scope":"static","$longname":"DocmaWeb.Utils.isModule","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isModule"},{"comment":"/**\n * Checks whether the given symbol is a namespace.\n * @name DocmaWeb.Utils.isNamespace\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":328,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a namespace.","name":"isNamespace","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isNamespace","scope":"static","$longname":"DocmaWeb.Utils.isNamespace","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isNamespace"},{"comment":"/**\n * Checks whether the given symbol has `package` private access; indicating\n * that the symbol is available only to code in the same directory as the\n * source file for this symbol.\n * @name DocmaWeb.Utils.isPackagePrivate\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":668,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `package` private access; indicating\n that the symbol is available only to code in the same directory as the\n source file for this symbol.","name":"isPackagePrivate","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isPackagePrivate","scope":"static","$longname":"DocmaWeb.Utils.isPackagePrivate","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isPackagePrivate"},{"comment":"/**\n * Checks whether the given symbol has `private` access.\n * @name DocmaWeb.Utils.isPrivate\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":656,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `private` access.","name":"isPrivate","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isPrivate","scope":"static","$longname":"DocmaWeb.Utils.isPrivate","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isPrivate"},{"comment":"/**\n * Checks whether the given symbol is a property (and not a method/function).\n * @name DocmaWeb.Utils.isProperty\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":510,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a property (and not a method/function).","name":"isProperty","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isProperty","scope":"static","$longname":"DocmaWeb.Utils.isProperty","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isProperty"},{"comment":"/**\n * Checks whether the given symbol has `protected` access.\n * @name DocmaWeb.Utils.isProtected\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":682,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `protected` access.","name":"isProtected","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isProtected","scope":"static","$longname":"DocmaWeb.Utils.isProtected","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isProtected"},{"comment":"/**\n * Checks whether the given symbol has `public` access.\n * @name DocmaWeb.Utils.isPublic\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":644,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol has `public` access.","name":"isPublic","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isPublic","scope":"static","$longname":"DocmaWeb.Utils.isPublic","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isPublic"},{"comment":"/**\n * Checks whether the given symbol is read-only.\n * @name DocmaWeb.Utils.isReadOnly\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":632,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is read-only.","name":"isReadOnly","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isReadOnly","scope":"static","$longname":"DocmaWeb.Utils.isReadOnly","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isReadOnly"},{"comment":"/**\n * Checks whether the given symbol is a static member.\n * @name DocmaWeb.Utils.isStaticMember\n * @function\n * @alias isStatic\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":410,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a static member.","name":"isStaticMember","kind":"function","alias":"isStatic","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isStaticMember","$longname":"DocmaWeb.Utils.isStaticMember","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isStaticMember"},{"comment":"/**\n * Checks whether the given symbol is a static method.\n * @name DocmaWeb.Utils.isStaticMethod\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":498,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a static method.","name":"isStaticMethod","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isStaticMethod","scope":"static","$longname":"DocmaWeb.Utils.isStaticMethod","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isStaticMethod"},{"comment":"/**\n * Checks whether the given symbol is a static property.\n * @name DocmaWeb.Utils.isStaticProperty\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":534,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a static property.","name":"isStaticProperty","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isStaticProperty","scope":"static","$longname":"DocmaWeb.Utils.isStaticProperty","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isStaticProperty"},{"comment":"/**\n * Checks whether the given symbol is a custom type definition.\n * @name DocmaWeb.Utils.isTypeDef\n * @function\n * @alias isCustomType\n * @static\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":546,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is a custom type definition.","name":"isTypeDef","kind":"function","alias":"isCustomType","scope":"static","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isTypeDef","$longname":"DocmaWeb.Utils.isTypeDef","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isTypeDef"},{"comment":"/**\n * Checks whether the given symbol is undocumented.\n * This checks if the symbol has any comments.\n * @name DocmaWeb.Utils.isUndocumented\n * @function\n *\n * @param {Object} symbol - Documented symbol object.\n * @returns {Boolean} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":694,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Checks whether the given symbol is undocumented.\n This checks if the symbol has any comments.","name":"isUndocumented","kind":"function","params":[{"type":{"names":["Object"]},"description":"Documented symbol object.","name":"symbol"}],"returns":[{"type":{"names":["Boolean"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.isUndocumented","scope":"static","$longname":"DocmaWeb.Utils.isUndocumented","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.isUndocumented"},{"comment":"/**\n * Normalizes the number of spaces/tabs to multiples of 2 spaces, in the\n * beginning of each line. Useful for fixing mixed indets of a description\n * or example.\n * @name DocmaWeb.Utils.normalizeTabs\n * @function\n *\n * @param {String} string - String to process.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":864,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Normalizes the number of spaces/tabs to multiples of 2 spaces, in the\n beginning of each line. Useful for fixing mixed indets of a description\n or example.","name":"normalizeTabs","kind":"function","params":[{"type":{"names":["String"]},"description":"String to process.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.normalizeTabs","scope":"static","$longname":"DocmaWeb.Utils.normalizeTabs","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.normalizeTabs"},{"comment":"/**\n * Gets the value of the target property by the given dot\n * {@link https://github.com/onury/notation|notation}.\n * @name DocmaWeb.Utils.notate\n * @function\n * @static\n *\n * @param {Object} obj - Source object.\n * @param {String} notation - Path of the property in dot-notation.\n *\n * @returns {*} - The value of the notation. If the given notation does\n * not exist, safely returns `undefined`.\n *\n * @example\n * var symbol = { code: { meta: { type: \"MethodDefinition\" } } };\n * DocmaWeb.Utils.notate(symbol, \"code.meta.type\"); // returns \"MethodDefinition\"\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":88,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the value of the target property by the given dot\n {@link https://github.com/onury/notation|notation}.","name":"notate","kind":"function","scope":"static","params":[{"type":{"names":["Object"]},"description":"Source object.","name":"obj"},{"type":{"names":["String"]},"description":"Path of the property in dot-notation.","name":"notation"}],"returns":[{"type":{"names":["*"]},"description":"- The value of the notation. If the given notation does\n not exist, safely returns `undefined`."}],"examples":["var symbol = { code: { meta: { type: \"MethodDefinition\" } } };\n DocmaWeb.Utils.notate(symbol, \"code.meta.type\"); // returns \"MethodDefinition\""],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.notate","$longname":"DocmaWeb.Utils.notate","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.notate"},{"comment":"/**\n * Parses the given string into proper HTML. Removes leading whitespace,\n * converts new lines to paragraphs, ticks to code tags and JSDoc links to\n * anchors.\n * @name DocmaWeb.Utils.parse\n * @function\n *\n * @param {String} string - String to be parsed.\n * @param {Object} [options] - Parse options.\n * @param {Object} [options.keepIfSingle=false]\n * If enabled, single lines will not be converted to paragraphs.\n * @param {String} [options.target]\n * Href target for links. e.g. `\"_blank\"`\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":840,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Parses the given string into proper HTML. Removes leading whitespace,\n converts new lines to paragraphs, ticks to code tags and JSDoc links to\n anchors.","name":"parse","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"},{"type":{"names":["Object"]},"optional":true,"description":"Parse options.","name":"options"},{"type":{"names":["Object"]},"optional":true,"defaultvalue":false,"description":"If enabled, single lines will not be converted to paragraphs.","name":"options.keepIfSingle"},{"type":{"names":["String"]},"optional":true,"description":"Href target for links. e.g. `\"_blank\"`","name":"options.target"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parse","scope":"static","$longname":"DocmaWeb.Utils.parse","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parse"},{"comment":"/**\n * Converts JSDoc `@link` directives to HTML anchor tags.\n * @name DocmaWeb.Utils.parseLinks\n * @function\n *\n * @param {String} string - String to be parsed.\n * @param {Object} [options] - Parse options.\n * @param {String} [options.target] - Href target. e.g. `\"_blank\"`\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":800,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Converts JSDoc `@link` directives to HTML anchor tags.","name":"parseLinks","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"},{"type":{"names":["Object"]},"optional":true,"description":"Parse options.","name":"options"},{"type":{"names":["String"]},"optional":true,"description":"Href target. e.g. `\"_blank\"`","name":"options.target"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parseLinks","scope":"static","$longname":"DocmaWeb.Utils.parseLinks","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parseLinks"},{"comment":"/**\n * Converts new lines to HTML paragraphs.\n * @name DocmaWeb.Utils.parseNewLines\n * @function\n *\n * @param {String} string - String to be parsed.\n * @param {Object} [options] - Parse options.\n * @param {Boolean} [options.keepIfSingle=false]\n * If `true`, lines will not be converted to paragraphs.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":774,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Converts new lines to HTML paragraphs.","name":"parseNewLines","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"},{"type":{"names":["Object"]},"optional":true,"description":"Parse options.","name":"options"},{"type":{"names":["Boolean"]},"optional":true,"defaultvalue":false,"description":"If `true`, lines will not be converted to paragraphs.","name":"options.keepIfSingle"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parseNewLines","scope":"static","$longname":"DocmaWeb.Utils.parseNewLines","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parseNewLines"},{"comment":"/**\n * Converts back-ticks to HTML code tags.\n * @name DocmaWeb.Utils.parseTicks\n * @function\n *\n * @param {String} string\n * String to be parsed.\n *\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":749,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Converts back-ticks to HTML code tags.","name":"parseTicks","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be parsed.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.parseTicks","scope":"static","$longname":"DocmaWeb.Utils.parseTicks","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.parseTicks"},{"comment":"/**\n * Removes leading spaces and dashes. Useful when displaying symbol\n * descriptions.\n * @name DocmaWeb.Utils.trimLeft\n * @function\n *\n * @param {String} string - String to be trimmed.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":723,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Removes leading spaces and dashes. Useful when displaying symbol\n descriptions.","name":"trimLeft","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be trimmed.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.trimLeft","scope":"static","$longname":"DocmaWeb.Utils.trimLeft","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.trimLeft"},{"comment":"/**\n * Removes leading and trailing new lines.\n * @name DocmaWeb.Utils.trimNewLines\n * @function\n *\n * @param {String} string - String to be trimmed.\n * @returns {String} -\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":737,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Removes leading and trailing new lines.","name":"trimNewLines","kind":"function","params":[{"type":{"names":["String"]},"description":"String to be trimmed.","name":"string"}],"returns":[{"type":{"names":["String"]},"description":"-"}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.trimNewLines","scope":"static","$longname":"DocmaWeb.Utils.trimNewLines","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.trimNewLines"},{"comment":"/**\n * Gets the type of the given object.\n * @name DocmaWeb.Utils.type\n * @function\n * @static\n *\n * @param {*} obj - Object to be inspected.\n * @returns {String} - Lower-case name of the type.\n */","meta":{"filename":"DocmaWeb.Utils.js","lineno":72,"columnno":0,"path":"/Users/a.golub/projects/gh/qiwi-forks/docma/lib/web","code":{}},"description":"Gets the type of the given object.","name":"type","kind":"function","scope":"static","params":[{"type":{"names":["*"]},"description":"Object to be inspected.","name":"obj"}],"returns":[{"type":{"names":["String"]},"description":"- Lower-case name of the type."}],"memberof":"DocmaWeb.Utils","longname":"DocmaWeb.Utils.type","$longname":"DocmaWeb.Utils.type","$kind":"method","$docmaLink":"api/web/utils/#DocmaWeb.Utils.type"}]}]}],"symbols":["DocmaWeb","DocmaWeb.Utils","DocmaWeb.Utils.DOM","DocmaWeb.Utils.DOM.getOffset","DocmaWeb.Utils.DOM.scrollTo","DocmaWeb.Utils.getCodeFileInfo","DocmaWeb.Utils.getCodeName","DocmaWeb.Utils.getCodeTags","DocmaWeb.Utils.getEmittedEvents","DocmaWeb.Utils.getFormattedTypeList","DocmaWeb.Utils.getKeywords","DocmaWeb.Utils.getLevels","DocmaWeb.Utils.getLongName","DocmaWeb.Utils.getName","DocmaWeb.Utils.getParent","DocmaWeb.Utils.getParentName","DocmaWeb.Utils.getReturnTypes","DocmaWeb.Utils.getSymbolByName","DocmaWeb.Utils.getSymbolLink","DocmaWeb.Utils.getTypes","DocmaWeb.Utils.hasDescription","DocmaWeb.Utils.isCallback","DocmaWeb.Utils.isClass","DocmaWeb.Utils.isConstant","DocmaWeb.Utils.isConstructor","DocmaWeb.Utils.isDeprecated","DocmaWeb.Utils.isEnum","DocmaWeb.Utils.isEvent","DocmaWeb.Utils.isExternal","DocmaWeb.Utils.isGenerator","DocmaWeb.Utils.isGlobal","DocmaWeb.Utils.isInner","DocmaWeb.Utils.isInstanceMember","DocmaWeb.Utils.isInstanceMethod","DocmaWeb.Utils.isInstanceProperty","DocmaWeb.Utils.isInterface","DocmaWeb.Utils.isMethod","DocmaWeb.Utils.isMixin","DocmaWeb.Utils.isModule","DocmaWeb.Utils.isNamespace","DocmaWeb.Utils.isPackagePrivate","DocmaWeb.Utils.isPrivate","DocmaWeb.Utils.isProperty","DocmaWeb.Utils.isProtected","DocmaWeb.Utils.isPublic","DocmaWeb.Utils.isReadOnly","DocmaWeb.Utils.isStaticMember","DocmaWeb.Utils.isStaticMethod","DocmaWeb.Utils.isStaticProperty","DocmaWeb.Utils.isTypeDef","DocmaWeb.Utils.isUndocumented","DocmaWeb.Utils.normalizeTabs","DocmaWeb.Utils.notate","DocmaWeb.Utils.parse","DocmaWeb.Utils.parseLinks","DocmaWeb.Utils.parseNewLines","DocmaWeb.Utils.parseTicks","DocmaWeb.Utils.trimLeft","DocmaWeb.Utils.trimNewLines","DocmaWeb.Utils.type"]}},"app":{"title":"Docma Documentation","meta":null,"base":"./","entrance":"content:home","routing":{"method":"path","caseSensitive":true},"server":"github","favicon":"./favicon.ico"},"template":{"name":"docma-template-zebra","description":"Zebra - Default template for Docma. https://github.com/onury/docma","version":"2.3.1","supportedDocmaVersion":">=2.0.0","author":"Onur Yıldırım","license":"MIT","mainHTML":"index.html","options":{"title":{"label":"Docma","href":"."},"logo":{"dark":"img/docma-logo.png","light":"img/docma-logo.png"},"sidebar":{"enabled":true,"outline":"tree","collapsed":false,"toolbar":true,"itemsFolded":false,"itemsOverflow":"crop","badges":true,"search":true,"animations":true},"symbols":{"autoLink":true,"params":"list","enums":"list","props":"list","meta":false},"contentView":{"bookmarks":"h1,h2,h3","faLibs":"all","faVersion":"5.5.0"},"navbar":{"enabled":true,"fixed":true,"dark":false,"animations":true,"menu":[{"iconClass":"fas fa-book","label":"Building Docs","items":[{"label":"Guide","href":"."},{"separator":true},{"label":"Docma (Builder) API","href":"api"},{"label":"Build Configuration","href":"api/#Docma~BuildConfiguration"}],"chevron":true},{"iconClass":"fas fa-puzzle-piece","label":"Templates","items":[{"label":"Default Template - Zebra","href":"templates/zebra"},{"separator":true},{"label":"Docma Template API","href":"api/#Docma.Template"},{"label":"Docma Web API","href":"api/web"}],"chevron":true},{"iconClass":"fas fa-cloud-download-alt","label":"Download","items":[{"label":"npm i @jacekpietal/docma -D","href":"https://www.npmjs.com/package/@jacekpietal/docma","target":"_blank"},{"label":"Docma Releases","href":"https://github.com/Prozi/docma/releases","target":"_blank"},{"separator":true},{"label":"Change Log","href":"changelog"}],"chevron":true},{"iconClass":"fab fa-lg fa-github","label":"","href":"https://github.com/Prozi/docma","target":"_blank"}]}}},"partials":{"api":"docma-api","content":"docma-content","notFound":"docma-404"},"elementID":"docma-main","contentElementID":"docma-content","defaultApiName":"_def_","logsEnabled":true}));
!function(){"use strict";var c="path"===docma.app.routing.method;function o(a){return(a.params[1]||"").replace(/\/$/,"")}function a(a,e){a=o(a)||docma._.defaultApiName,a=docma.createRoute(a,DocmaWeb.Route.Type.API);if(!a||!a.exists())return e();a.apply()}docma.app.base&&page.base(docma.app.base),page.redirect("(/)?"+docma.template.main,""),c&&(page("(/)?api/(.+)",a),page("(/)?api(/)?",a),page("(/)?(.*)",function(a,e){a=o(a),a=docma.createRoute(a,DocmaWeb.Route.Type.CONTENT);if(!a||!a.exists())return e();a.apply()})),page("(/)?",function(t,n){!function(){if(c){var a=sessionStorage.getItem("redirectPath")||null;if(a)return sessionStorage.removeItem("redirectPath"),docma.info("Redirecting to:",a),page.redirect(a),1}}()&&setTimeout(function(){var a,e,e=(e=(e=t.querystring)||window.location.search,(e=/^[?&]/.test(e)?e.slice(1):e)||null);if(c){if(e)return n();a=docma._.appEntranceRI}else docma.log("Query-string:",e),a=e?docma.createRouteFromQuery(e):docma._.appEntranceRI;if(!a||!a.exists())return n();function o(){docma._trigger(DocmaWeb.Event.Navigate,[a])}a.isCurrent()?o():a.apply(function(a){200===a&&o()})},100)}),page("*",function(a){docma.warn("Unknown Route:",a.path),docma.log("context:",a),docma.createRoute(null).apply()}),docma.info("Docma SPA Configuration:"),docma.info("App Title: ",docma.app.title),docma.info("Routing Method: ",docma.app.routing.method),docma.info("App Server: ",docma.app.server),docma.info("Base Path: ",docma.app.base),docma.info("Entrance Route ID: ",docma.app.entrance),window.onload=function(){docma._.initialLoad=!0,docma._.appEntranceRI=docma.createRouteFromID(docma.app.entrance),page.start({click:!0,popstate:!0,dispatch:!0,hashbang:!1,decodeURLComponents:!0}),docma.info("Docma SPA loaded!")}}();
\ No newline at end of file
diff --git a/lib/web/assets/docma.less b/lib/web/assets/docma.less
index 9bdc810..e69de29 100644
--- a/lib/web/assets/docma.less
+++ b/lib/web/assets/docma.less
@@ -1,80 +0,0 @@
-// Size the emoji according to the surrounding text: This will make sure emoji
-// derive their width and height from the font-size of the text they're shown
-// with. It also adds just a little bit of space before and after each emoji,
-// and pulls them upwards a little bit for better optical alignment.
-// https://github.com/twitter/twemoji#inline-styles
-img.docma {
- display: inline-block;
- border: 0 none;
-
- &.emoji,
- &.emoji-sm,
- &.emoji-1x {
- height: 1em;
- width: 1em;
- margin: 0 0.05em 0 0.1em;
- vertical-align: -0.1em;
- }
-
- &.emoji-md {
- height: 1.33em;
- width: 1.33em;
- margin: 0 0.0665em 0 0.133em;
- vertical-align: -0.133em;
- }
-
- &.emoji-lg {
- height: 1.66em;
- width: 1.66em;
- margin: 0 0.083em 0 0.166em;
- vertical-align: -0.166em;
- }
-
- .emoji-2x {
- height: 2em;
- width: 2em;
- margin: 0 0.1em 0 0.2em;
- vertical-align: -0.2em;
- }
-
- .emoji-3x {
- height: 3em;
- width: 3em;
- margin: 0 0.15em 0 0.3em;
- vertical-align: -0.3em;
- }
-
- .emoji-4x {
- height: 4em;
- width: 4em;
- margin: 0 0.2em 0 0.4em;
- vertical-align: -0.4em;
- }
-
- .emoji-5x {
- height: 5em;
- width: 5em;
- margin: 0 0.25em 0 0.5em;
- vertical-align: -0.5em;
- }
-}
-
-ul.docma.task-list {
- list-style: none;
- padding-left: 0;
- margin-left: 0;
-
- & > li.docma.task-item {
- padding-left: 0;
- margin-left: 0;
- }
-}
-
-.docma-hide,
-.docma-ignore {
- position: absolute !important;
- display: none !important;
- visibility: hidden !important;
- opacity: 0 !important;
- margin-right: 2000px;
-}
diff --git a/package.json b/package.json
index d246e3e..f22832d 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@qiwi/docma",
- "version": "0.0.0",
+ "version": "3.3.3",
"description": "A powerful dev-tool to easily generate beautiful HTML documentation from Javascript (JSDoc), Markdown and HTML files.",
"license": "MIT",
"author": {
diff --git a/yarn.lock b/yarn.lock
index f545cfc..9ba5235 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -732,6 +732,11 @@ ansi-escapes@^4.2.1:
dependencies:
type-fest "^0.21.3"
+ansi-regex@^2.0.0:
+ version "2.1.1"
+ resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df"
+ integrity sha1-w7M6te42DYbg5ijwRorn7yfWVN8=
+
ansi-regex@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-3.0.0.tgz#ed0317c322064f79466c02966bddb605ab37d998"
@@ -1116,6 +1121,11 @@ callsites@^3.0.0:
resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73"
integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==
+camelcase@^4.1.0:
+ version "4.1.0"
+ resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-4.1.0.tgz#d545635be1e33c542649c69173e5de6acfae34dd"
+ integrity sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=
+
camelcase@^5.0.0, camelcase@^5.3.1:
version "5.3.1"
resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320"
@@ -1245,6 +1255,15 @@ cli@^1.0.1:
exit "0.1.2"
glob "^7.1.1"
+cliui@^4.0.0:
+ version "4.1.0"
+ resolved "https://registry.yarnpkg.com/cliui/-/cliui-4.1.0.tgz#348422dbe82d800b3022eef4f6ac10bf2e4d1b49"
+ integrity sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ==
+ dependencies:
+ string-width "^2.1.1"
+ strip-ansi "^4.0.0"
+ wrap-ansi "^2.0.0"
+
cliui@^6.0.0:
version "6.0.0"
resolved "https://registry.yarnpkg.com/cliui/-/cliui-6.0.0.tgz#511d702c0c4e41ca156d7d0e96021f23e13225b1"
@@ -1280,6 +1299,11 @@ co@^4.6.0:
resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184"
integrity sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=
+code-point-at@^1.0.0:
+ version "1.1.0"
+ resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77"
+ integrity sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=
+
collect-v8-coverage@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/collect-v8-coverage/-/collect-v8-coverage-1.0.1.tgz#cc2c8e94fc18bbdffe64d6534570c8a673b27f59"
@@ -1410,6 +1434,15 @@ core-util-is@1.0.2, core-util-is@~1.0.0:
resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"
integrity sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=
+cross-spawn@^5.0.1:
+ version "5.1.0"
+ resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-5.1.0.tgz#e8bd0efee58fcff6f8f94510a0a554bbfa235449"
+ integrity sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk=
+ dependencies:
+ lru-cache "^4.0.1"
+ shebang-command "^1.2.0"
+ which "^1.2.9"
+
cross-spawn@^6.0.0:
version "6.0.5"
resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-6.0.5.tgz#4a5ec7c64dfae22c3a14124dbacdee846d80cbc4"
@@ -1484,7 +1517,7 @@ debug@^4.0.1, debug@^4.1.0, debug@^4.1.1:
dependencies:
ms "2.1.2"
-decamelize@^1.2.0:
+decamelize@^1.1.1, decamelize@^1.2.0:
version "1.2.0"
resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=
@@ -1857,6 +1890,19 @@ exec-sh@^0.3.2:
resolved "https://registry.yarnpkg.com/exec-sh/-/exec-sh-0.3.6.tgz#ff264f9e325519a60cb5e273692943483cca63bc"
integrity sha512-nQn+hI3yp+oD0huYhKwvYI32+JFeq+XkNcD1GAo3Y/MjxsfVGmrrzrnzjWiNY6f+pUCP440fThsFh5gZrRAU/w==
+execa@^0.7.0:
+ version "0.7.0"
+ resolved "https://registry.yarnpkg.com/execa/-/execa-0.7.0.tgz#944becd34cc41ee32a63a9faf27ad5a65fc59777"
+ integrity sha1-lEvs00zEHuMqY6n68nrVpl/Fl3c=
+ dependencies:
+ cross-spawn "^5.0.1"
+ get-stream "^3.0.0"
+ is-stream "^1.1.0"
+ npm-run-path "^2.0.0"
+ p-finally "^1.0.0"
+ signal-exit "^3.0.0"
+ strip-eof "^1.0.0"
+
execa@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/execa/-/execa-1.0.0.tgz#c6236a5bb4df6d6f15e88e7f017798216749ddd8"
@@ -2092,6 +2138,13 @@ finalhandler@~1.1.2:
statuses "~1.5.0"
unpipe "~1.0.0"
+find-up@^2.1.0:
+ version "2.1.0"
+ resolved "https://registry.yarnpkg.com/find-up/-/find-up-2.1.0.tgz#45d1b7e506c717ddd482775a2b77920a3c0c57a7"
+ integrity sha1-RdG35QbHF93UgndaK3eSCjwMV6c=
+ dependencies:
+ locate-path "^2.0.0"
+
find-up@^4.0.0, find-up@^4.1.0:
version "4.1.0"
resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19"
@@ -2208,6 +2261,11 @@ gensync@^1.0.0-beta.2:
resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0"
integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==
+get-caller-file@^1.0.1:
+ version "1.0.3"
+ resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-1.0.3.tgz#f978fa4c90d1dfe7ff2d6beda2a515e713bdcf4a"
+ integrity sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w==
+
get-caller-file@^2.0.1, get-caller-file@^2.0.5:
version "2.0.5"
resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e"
@@ -2227,6 +2285,11 @@ get-package-type@^0.1.0:
resolved "https://registry.yarnpkg.com/get-package-type/-/get-package-type-0.1.0.tgz#8de2d803cff44df3bc6c456e6668b36c3926e11a"
integrity sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==
+get-stream@^3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-3.0.0.tgz#8e943d1358dc37555054ecbe2edb05aa174ede14"
+ integrity sha1-jpQ9E1jcN1VQVOy+LtsFqhdO3hQ=
+
get-stream@^4.0.0:
version "4.1.0"
resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-4.1.0.tgz#c1b255575f3dc21d59bfc79cd3d2b46b1c3a54b5"
@@ -2553,6 +2616,11 @@ inquirer@^8.0.0:
strip-ansi "^6.0.0"
through "^2.3.6"
+invert-kv@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/invert-kv/-/invert-kv-1.0.0.tgz#104a8e4aaca6d3d8cd157a8ef8bfab2d7a3ffdb6"
+ integrity sha1-EEqOSqym09jNFXqO+L+rLXo//bY=
+
ipaddr.js@1.9.1:
version "1.9.1"
resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3"
@@ -2681,6 +2749,18 @@ is-extglob@^2.1.1:
resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2"
integrity sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=
+is-fullwidth-code-point@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz#ef9e31386f031a7f0d643af82fde50c457ef00cb"
+ integrity sha1-754xOG8DGn8NZDr4L95QxFfvAMs=
+ dependencies:
+ number-is-nan "^1.0.0"
+
+is-fullwidth-code-point@^2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz#a3b30a5c4f199183167aaab93beefae3ddfb654f"
+ integrity sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=
+
is-fullwidth-code-point@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d"
@@ -3426,6 +3506,13 @@ kleur@^3.0.3:
resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e"
integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==
+lcid@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/lcid/-/lcid-1.0.0.tgz#308accafa0bc483a3867b4b6f2b9506251d1b835"
+ integrity sha1-MIrMr6C8SDo4Z7S28rlQYlHRuDU=
+ dependencies:
+ invert-kv "^1.0.0"
+
less-plugin-clean-css@^1.5.1:
version "1.5.1"
resolved "https://registry.yarnpkg.com/less-plugin-clean-css/-/less-plugin-clean-css-1.5.1.tgz#cc57af7aa3398957e56decebe63cb60c23429703"
@@ -3483,6 +3570,14 @@ linkify-it@^2.0.0:
dependencies:
uc.micro "^1.0.1"
+locate-path@^2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e"
+ integrity sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=
+ dependencies:
+ p-locate "^2.0.0"
+ path-exists "^3.0.0"
+
locate-path@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0"
@@ -3520,6 +3615,14 @@ lowercase-keys@^2.0.0:
resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-2.0.0.tgz#2603e78b7b4b0006cbca2fbcc8a3202558ac9479"
integrity sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==
+lru-cache@^4.0.1:
+ version "4.1.5"
+ resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.1.5.tgz#8bbe50ea85bed59bc9e33dcab8235ee9bcf443cd"
+ integrity sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==
+ dependencies:
+ pseudomap "^1.0.2"
+ yallist "^2.1.2"
+
lru-cache@^6.0.0:
version "6.0.0"
resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94"
@@ -3597,6 +3700,13 @@ media-typer@0.3.0:
resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
+mem@^1.1.0:
+ version "1.1.0"
+ resolved "https://registry.yarnpkg.com/mem/-/mem-1.1.0.tgz#5edd52b485ca1d900fe64895505399a0dfa45f76"
+ integrity sha1-Xt1StIXKHZAP5kiVUFOZoN+kX3Y=
+ dependencies:
+ mimic-fn "^1.0.0"
+
merge-descriptors@1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-1.0.1.tgz#b00aaa556dd8b44568150ec9d1b953f3f90cbb61"
@@ -3675,6 +3785,11 @@ mime@1.6.0, mime@^1.4.1:
resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1"
integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==
+mimic-fn@^1.0.0:
+ version "1.2.0"
+ resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-1.2.0.tgz#820c86a39334640e99516928bd03fca88057d022"
+ integrity sha512-jf84uxzwiuiIVKiOLpfYk7N46TSy8ubTonmneY9vrpHNAnp0QBt2BxWV9dO3/j+BoVAb+a5G6YDPW3M5HOdMWQ==
+
mimic-fn@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b"
@@ -3869,6 +3984,11 @@ npm-run-path@^4.0.0:
dependencies:
path-key "^3.0.0"
+number-is-nan@^1.0.0:
+ version "1.0.1"
+ resolved "https://registry.yarnpkg.com/number-is-nan/-/number-is-nan-1.0.1.tgz#097b602b53422a522c1afb8790318336941a011d"
+ integrity sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=
+
nwsapi@^2.2.0:
version "2.2.0"
resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.0.tgz#204879a9e3d068ff2a55139c2c772780681a38b7"
@@ -3965,6 +4085,15 @@ org-regex@^1.0.0:
resolved "https://registry.yarnpkg.com/org-regex/-/org-regex-1.0.0.tgz#67ebb9ab3cb124fea5841289d60b59434f041a59"
integrity sha512-7bqkxkEJwzJQUAlyYniqEZ3Ilzjh0yoa62c7gL6Ijxj5bEpPL+8IE1Z0PFj0ywjjXQcdrwR51g9MIcLezR0hKQ==
+os-locale@^2.0.0:
+ version "2.1.0"
+ resolved "https://registry.yarnpkg.com/os-locale/-/os-locale-2.1.0.tgz#42bc2900a6b5b8bd17376c8e882b65afccf24bf2"
+ integrity sha512-3sslG3zJbEYcaC4YVAvDorjGxc7tv6KVATnLPZONiljsUncvihe9BQoVCEs0RZ1kmf4Hk9OBqlZfJZWI4GanKA==
+ dependencies:
+ execa "^0.7.0"
+ lcid "^1.0.0"
+ mem "^1.1.0"
+
os-tmpdir@~1.0.2:
version "1.0.2"
resolved "https://registry.yarnpkg.com/os-tmpdir/-/os-tmpdir-1.0.2.tgz#bbe67406c79aa85c5cfec766fe5734555dfa1274"
@@ -3992,6 +4121,13 @@ p-finally@^1.0.0:
resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae"
integrity sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=
+p-limit@^1.1.0:
+ version "1.3.0"
+ resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-1.3.0.tgz#b86bd5f0c25690911c7590fcbfc2010d54b3ccb8"
+ integrity sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==
+ dependencies:
+ p-try "^1.0.0"
+
p-limit@^2.2.0:
version "2.3.0"
resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1"
@@ -3999,6 +4135,13 @@ p-limit@^2.2.0:
dependencies:
p-try "^2.0.0"
+p-locate@^2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-2.0.0.tgz#20a0103b222a70c8fd39cc2e580680f3dde5ec43"
+ integrity sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=
+ dependencies:
+ p-limit "^1.1.0"
+
p-locate@^4.1.0:
version "4.1.0"
resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07"
@@ -4020,6 +4163,11 @@ p-timeout@^3.1.0:
dependencies:
p-finally "^1.0.0"
+p-try@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/p-try/-/p-try-1.0.0.tgz#cbc79cdbaf8fd4228e13f621f2b1a237c1b207b3"
+ integrity sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=
+
p-try@^2.0.0:
version "2.2.0"
resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6"
@@ -4072,6 +4220,11 @@ pascalcase@^0.1.1:
resolved "https://registry.yarnpkg.com/pascalcase/-/pascalcase-0.1.1.tgz#b363e55e8006ca6fe21784d2db22bd15d7917f14"
integrity sha1-s2PlXoAGym/iF4TS2yK9FdeRfxQ=
+path-exists@^3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515"
+ integrity sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=
+
path-exists@^4.0.0:
version "4.0.0"
resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3"
@@ -4199,6 +4352,11 @@ prr@~1.0.1:
resolved "https://registry.yarnpkg.com/prr/-/prr-1.0.1.tgz#d3fc114ba06995a45ec6893f484ceb1d78f5f476"
integrity sha1-0/wRS6BplaRexok/SEzrHXj19HY=
+pseudomap@^1.0.2:
+ version "1.0.2"
+ resolved "https://registry.yarnpkg.com/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3"
+ integrity sha1-8FKijacOYYkX7wqKw0wa5aaChrM=
+
psl@^1.1.28, psl@^1.1.33:
version "1.8.0"
resolved "https://registry.yarnpkg.com/psl/-/psl-1.8.0.tgz#9326f8bcfb013adcc005fdff056acce020e51c24"
@@ -4399,6 +4557,11 @@ require-from-string@^2.0.2:
resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909"
integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==
+require-main-filename@^1.0.1:
+ version "1.0.1"
+ resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-1.0.1.tgz#97f717b69d48784f5f526a6c5aa8ffdda055a4d1"
+ integrity sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE=
+
require-main-filename@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-2.0.0.tgz#d0b329ecc7cc0f61649f62215be69af54aa8989b"
@@ -4832,6 +4995,23 @@ string-length@^4.0.1:
char-regex "^1.0.2"
strip-ansi "^6.0.0"
+string-width@^1.0.1:
+ version "1.0.2"
+ resolved "https://registry.yarnpkg.com/string-width/-/string-width-1.0.2.tgz#118bdf5b8cdc51a2a7e70d211e07e2b0b9b107d3"
+ integrity sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=
+ dependencies:
+ code-point-at "^1.0.0"
+ is-fullwidth-code-point "^1.0.0"
+ strip-ansi "^3.0.0"
+
+string-width@^2.0.0, string-width@^2.1.1:
+ version "2.1.1"
+ resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.1.1.tgz#ab93f27a8dc13d28cac815c462143a6d9012ae9e"
+ integrity sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==
+ dependencies:
+ is-fullwidth-code-point "^2.0.0"
+ strip-ansi "^4.0.0"
+
string-width@^4.1.0, string-width@^4.2.0:
version "4.2.2"
resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.2.tgz#dafd4f9559a7585cfba529c6a0a4f73488ebd4c5"
@@ -4848,6 +5028,20 @@ string_decoder@~1.1.1:
dependencies:
safe-buffer "~5.1.0"
+strip-ansi@^3.0.0, strip-ansi@^3.0.1:
+ version "3.0.1"
+ resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-3.0.1.tgz#6a385fb8853d952d5ff05d0e8aaf94278dc63dcf"
+ integrity sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=
+ dependencies:
+ ansi-regex "^2.0.0"
+
+strip-ansi@^4.0.0:
+ version "4.0.0"
+ resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-4.0.0.tgz#a8479022eb1ac368a871389b635262c505ee368f"
+ integrity sha1-qEeQIusaw2iocTibY1JixQXuNo8=
+ dependencies:
+ ansi-regex "^3.0.0"
+
strip-ansi@^6.0.0:
version "6.0.0"
resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.0.tgz#0b1571dd7669ccd4f3e06e14ef1eed26225ae532"
@@ -5018,6 +5212,13 @@ toidentifier@1.0.0:
resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.0.tgz#7e1be3470f1e77948bc43d94a3c8f4d7752ba553"
integrity sha512-yaOH/Pk/VEhBWWTlhI+qXxDFXlejDGcQipMlyxda9nthulaxLZUNcUqFxokp0vcYnvteJln5FNQDRrxj3YcbVw==
+touch-for-windows@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/touch-for-windows/-/touch-for-windows-1.0.0.tgz#b50862db1131042c96b76b58fd2451e13d2e77f6"
+ integrity sha512-wEJjsfUyuv7VunF9tLDZ071A8+Ka1A7yrJYnktgrCE9ssGCNAzvRSUuqCUzIPe2rE0PnVujuq2dMpImpMgY8xQ==
+ dependencies:
+ yargs "^10.0.3"
+
tough-cookie@^2.3.3, tough-cookie@~2.5.0:
version "2.5.0"
resolved "https://registry.yarnpkg.com/tough-cookie/-/tough-cookie-2.5.0.tgz#cd9fb2a0aa1d5a12b473bd9fb96fa3dcff65ade2"
@@ -5329,6 +5530,14 @@ word-wrap@^1.2.3, word-wrap@~1.2.3:
resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==
+wrap-ansi@^2.0.0:
+ version "2.1.0"
+ resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-2.1.0.tgz#d8fc3d284dd05794fe84973caecdd1cf824fdd85"
+ integrity sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=
+ dependencies:
+ string-width "^1.0.1"
+ strip-ansi "^3.0.1"
+
wrap-ansi@^6.2.0:
version "6.2.0"
resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53"
@@ -5382,6 +5591,11 @@ xmlcreate@^2.0.3:
resolved "https://registry.yarnpkg.com/xmlcreate/-/xmlcreate-2.0.3.tgz#df9ecd518fd3890ab3548e1b811d040614993497"
integrity sha512-HgS+X6zAztGa9zIK3Y3LXuJes33Lz9x+YyTxgrkIdabu2vqcGOWwdfCpf1hWLRrd553wd4QCDf6BBO6FfdsRiQ==
+y18n@^3.2.1:
+ version "3.2.2"
+ resolved "https://registry.yarnpkg.com/y18n/-/y18n-3.2.2.tgz#85c901bd6470ce71fc4bb723ad209b70f7f28696"
+ integrity sha512-uGZHXkHnhF0XeeAPgnKfPv1bgKAYyVvmNL1xlKsPYZPaIHxGti2hHqvOCQv71XMsLxu1QjergkqogUnms5D3YQ==
+
y18n@^4.0.0:
version "4.0.3"
resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.3.tgz#b5f259c82cd6e336921efd7bfd8bf560de9eeedf"
@@ -5392,6 +5606,11 @@ y18n@^5.0.5:
resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55"
integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==
+yallist@^2.1.2:
+ version "2.1.2"
+ resolved "https://registry.yarnpkg.com/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52"
+ integrity sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=
+
yallist@^4.0.0:
version "4.0.0"
resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
@@ -5410,6 +5629,31 @@ yargs-parser@^20.2.2:
resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.7.tgz#61df85c113edfb5a7a4e36eb8aa60ef423cbc90a"
integrity sha512-FiNkvbeHzB/syOjIUxFDCnhSfzAL8R5vs40MgLFBorXACCOAEaWu0gRZl14vG8MR9AOJIZbmkjhusqBYZ3HTHw==
+yargs-parser@^8.1.0:
+ version "8.1.0"
+ resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-8.1.0.tgz#f1376a33b6629a5d063782944da732631e966950"
+ integrity sha512-yP+6QqN8BmrgW2ggLtTbdrOyBNSI7zBa4IykmiV5R1wl1JWNxQvWhMfMdmzIYtKU7oP3OOInY/tl2ov3BDjnJQ==
+ dependencies:
+ camelcase "^4.1.0"
+
+yargs@^10.0.3:
+ version "10.1.2"
+ resolved "https://registry.yarnpkg.com/yargs/-/yargs-10.1.2.tgz#454d074c2b16a51a43e2fb7807e4f9de69ccb5c5"
+ integrity sha512-ivSoxqBGYOqQVruxD35+EyCFDYNEFL/Uo6FcOnz+9xZdZzK0Zzw4r4KhbrME1Oo2gOggwJod2MnsdamSG7H9ig==
+ dependencies:
+ cliui "^4.0.0"
+ decamelize "^1.1.1"
+ find-up "^2.1.0"
+ get-caller-file "^1.0.1"
+ os-locale "^2.0.0"
+ require-directory "^2.1.1"
+ require-main-filename "^1.0.1"
+ set-blocking "^2.0.0"
+ string-width "^2.0.0"
+ which-module "^2.0.0"
+ y18n "^3.2.1"
+ yargs-parser "^8.1.0"
+
yargs@^15.4.1:
version "15.4.1"
resolved "https://registry.yarnpkg.com/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8"