gulp-yuidoc
Version:
A yuidoc plugin for Gulp
2,175 lines (868 loc) • 88.3 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>DocBuilder</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title=""></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: </em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/CLI.html">CLI</a></li>
<li><a href="../classes/DocBuilder.html">DocBuilder</a></li>
<li><a href="../classes/DocParser.html">DocParser</a></li>
<li><a href="../classes/DocView.html">DocView</a></li>
<li><a href="../classes/Files.html">Files</a></li>
<li><a href="../classes/Help.html">Help</a></li>
<li><a href="../classes/Main.html">Main</a></li>
<li><a href="../classes/Options.html">Options</a></li>
<li><a href="../classes/Server.html">Server</a></li>
<li><a href="../classes/Utils.html">Utils</a></li>
<li><a href="../classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/yuidoc.html">yuidoc</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>DocBuilder Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l12"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:12</code></a>
</div>
Module: <a href="../modules/yuidoc.html">yuidoc</a>
</div>
<div class="box intro">
<p>Takes the <code>JSON</code> data from the <code>DocParser</code> class, creates and parses markdown and handlebars
based templates to generate static HTML content</p>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method__addHelpers">_addHelpers</a>
</li>
<li class="index-item method private">
<a href="#method__inlineCode">_inlineCode</a>
</li>
<li class="index-item method private">
<a href="#method__mixExternal">_mixExternal</a>
</li>
<li class="index-item method private">
<a href="#method__parseCode">_parseCode</a>
</li>
<li class="index-item method private">
<a href="#method__parseCrossLink">_parseCrossLink</a>
</li>
<li class="index-item method">
<a href="#method_addFoundAt">addFoundAt</a>
</li>
<li class="index-item method">
<a href="#method_augmentData">augmentData</a>
</li>
<li class="index-item method">
<a href="#method_compile">compile</a>
</li>
<li class="index-item method">
<a href="#method_filterFileName">filterFileName</a>
</li>
<li class="index-item method">
<a href="#method_getProjectMeta">getProjectMeta</a>
</li>
<li class="index-item method">
<a href="#method_hasProperty">hasProperty</a>
</li>
<li class="index-item method">
<a href="#method_makeDirs">makeDirs</a>
</li>
<li class="index-item method private">
<a href="#method_markdown">markdown</a>
</li>
<li class="index-item method">
<a href="#method_mergeExtends">mergeExtends</a>
</li>
<li class="index-item method">
<a href="#method_mixExternal">mixExternal</a>
</li>
<li class="index-item method">
<a href="#method_nameSort">nameSort</a>
</li>
<li class="index-item method private">
<a href="#method_NATIVES_LINKER">NATIVES_LINKER</a>
</li>
<li class="index-item method">
<a href="#method_populateClasses">populateClasses</a>
</li>
<li class="index-item method">
<a href="#method_populateFiles">populateFiles</a>
</li>
<li class="index-item method">
<a href="#method_populateModules">populateModules</a>
</li>
<li class="index-item method">
<a href="#method_render">render</a>
</li>
<li class="index-item method">
<a href="#method_renderAPIMeta">renderAPIMeta</a>
</li>
<li class="index-item method">
<a href="#method_renderClass">renderClass</a>
</li>
<li class="index-item method">
<a href="#method_renderFile">renderFile</a>
</li>
<li class="index-item method">
<a href="#method_renderIndex">renderIndex</a>
</li>
<li class="index-item method">
<a href="#method_renderModule">renderModule</a>
</li>
<li class="index-item method">
<a href="#method_writeAPIMeta">writeAPIMeta</a>
</li>
<li class="index-item method">
<a href="#method_writeClasses">writeClasses</a>
</li>
<li class="index-item method">
<a href="#method_writeFiles">writeFiles</a>
</li>
<li class="index-item method">
<a href="#method_writeIndex">writeIndex</a>
</li>
<li class="index-item method">
<a href="#method_writeModules">writeModules</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property private">
<a href="#property__mergeCounter">_mergeCounter</a>
</li>
<li class="index-item property private">
<a href="#property__meta">_meta</a>
</li>
<li class="index-item property">
<a href="#property_files">files</a>
</li>
<li class="index-item property">
<a href="#property_NATIVES">NATIVES</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__addHelpers" class="method item">
<h3 class="name"><code>_addHelpers</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>helpers</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l120"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:120</code></a>
</p>
</div>
<div class="description">
<p>Register a <code>Y.Handlebars</code> helper method</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">helpers</code>
<span class="type">Object</span>
<div class="param-description">
<p>Object containing a hash of names and functions</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__inlineCode" class="method item private">
<h3 class="name"><code>_inlineCode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>html</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTML</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l770"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:770</code></a>
</p>
</div>
<div class="description">
<p>Ported from <a href="https://github.com/rgrove/selleck">Selleck</a>, this handles <code>`</code>'s in fields
that are not parsed by the <strong>Markdown</strong> parser.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type">HTML</span>
<div class="param-description">
<p>The HTML to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTML</span>:
<p>The parsed HTML</p>
</div>
</div>
</div>
<div id="method__mixExternal" class="method item private">
<h3 class="name"><code>_mixExternal</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l324"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:324</code></a>
</p>
</div>
<div class="description">
<p>Mixes the various external data soures together into the local data, augmenting
it with flags.</p>
</div>
</div>
<div id="method__parseCode" class="method item private">
<h3 class="name"><code>_parseCode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>html</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTML</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l757"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:757</code></a>
</p>
</div>
<div class="description">
<p>Parses <code><pre><code></code> tags and adds the <strong>prettyprint</strong> <code>className</code> to them</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type">HTML</span>
<div class="param-description">
<p>The HTML to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTML</span>:
<p>The parsed HTML</p>
</div>
</div>
</div>
<div id="method__parseCrossLink" class="method item private">
<h3 class="name"><code>_parseCrossLink</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>item</code>
</li>
<li class="arg">
<code class="optional">[raw=false]</code>
</li>
<li class="arg">
<code class="optional">[content]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l164"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:164</code></a>
</p>
</div>
<div class="description">
<p>Parse the item to be cross linked and return an HREF linked to the item</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">item</code>
<span class="type">String</span>
<div class="param-description">
<p>The item to crossLink</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[raw=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Do not wrap it in HTML</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[content]</code>
<span class="type">String</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>crossLink helper content</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_addFoundAt" class="method item">
<h3 class="name"><code>addFoundAt</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>a</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l622"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:622</code></a>
</p>
</div>
<div class="description">
<p>Parses file and line number from an item object and build's an HREF</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type">Object</span>
<div class="param-description">
<p>The item to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>The parsed HREF</p>
</div>
</div>
</div>
<div id="method_augmentData" class="method item">
<h3 class="name"><code>augmentData</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l638"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:638</code></a>
</p>
</div>
<div class="description">
<p>Augments the <strong>DocParser</strong> meta data to provide default values for certain keys as well as parses all descriptions
with the <code>Markdown Parser</code></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type">Object</span>
<div class="param-description">
<p>The object to recurse and augment</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<p>The augmented object</p>
</div>
</div>
</div>
<div id="method_compile" class="method item">
<h3 class="name"><code>compile</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l1605"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:1605</code></a>
</p>
</div>
<div class="description">
<p>Compiles the templates from the meta-data provided by DocParser</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_filterFileName" class="method item">
<h3 class="name"><code>filterFileName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l1592"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:1592</code></a>
</p>
</div>
<div class="description">
<p>Normalizes a file path to a writable filename:</p>
<p> var path = 'lib/file.js';
returns 'lib_file.js';</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type">String</span>
<div class="param-description">
<p>The filename to normalize</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>The filtered file path</p>
</div>
</div>
</div>
<div id="method_getProjectMeta" class="method item">
<h3 class="name"><code>getProjectMeta</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l452"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:452</code></a>
</p>
</div>
<div class="description">
<p>Prep the meta data to be fed to Selleck</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<p>The project metadata</p>
</div>
</div>
</div>
<div id="method_hasProperty" class="method item">
<h3 class="name"><code>hasProperty</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>a</code>
</li>
<li class="arg">
<code>b</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l1019"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:1019</code></a>
</p>
</div>
<div class="description">
<p>Checks an array of items (class items) to see if an item is in that list</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type">Array</span>
<div class="param-description">
<p>The Array of items to check</p>
</div>
</li>
<li class="param">
<code class="param-name">b</code>
<span class="type">Object</span>
<div class="param-description">
<p>The object to find</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>Boolean</p>
</div>
</div>
</div>
<div id="method_makeDirs" class="method item">
<h3 class="name"><code>makeDirs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l704"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:704</code></a>
</p>
</div>
<div class="description">
<p>Makes the default directories needed</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute after it's completed</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_markdown" class="method item private">
<h3 class="name"><code>markdown</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>md</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">HTML</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l137"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:137</code></a>
</p>
</div>
<div class="description">
<p>Wrapper around the Markdown parser so it can be normalized or even side stepped</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">md</code>
<span class="type">String</span>
<div class="param-description">
<p>The Markdown string to parse</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">HTML</span>:
<p>The rendered HTML</p>
</div>
</div>
</div>
<div id="method_mergeExtends" class="method item">
<h3 class="name"><code>mergeExtends</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>info</code>
</li>
<li class="arg">
<code>classItems</code>
</li>
<li class="arg">
<code>first</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l1043"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:1043</code></a>
</p>
</div>
<div class="description">
<p>Merge superclass data into a child class</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">info</code>
<span class="type">Object</span>
<div class="param-description">
<p>The item to extend</p>
</div>
</li>
<li class="param">
<code class="param-name">classItems</code>
<span class="type">Array</span>
<div class="param-description">
<p>The list of items to merge in</p>
</div>
</li>
<li class="param">
<code class="param-name">first</code>
<span class="type">Boolean</span>
<div class="param-description">
<p>Set for the first call</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_mixExternal" class="method item">
<h3 class="name"><code>mixExternal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cb</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag async">async</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l372"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:372</code></a>
</p>
</div>
<div class="description">
<p>Fetches the remote data and fires the callback when it's all complete</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cb</code>
<span class="type">Callback</span>
<div class="param-description">
<p>The callback to execute when complete</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_nameSort" class="method item">
<h3 class="name"><code>nameSort</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>a</code>
</li>
<li class="arg">
<code>b</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l1422"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:1422</code></a>
</p>
</div>
<div class="description">
<p>Sort method of array of objects with a property called <strong>name</strong></p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">a</code>
<span class="type">Object</span>
<div class="param-description">
<p>First object to compare</p>
</div>
</li>
<li class="param">
<code class="param-name">b</code>
<span class="type">Object</span>
<div class="param-description">
<p>Second object to compare</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Number</span>:
<p>1, -1 or 0 for sorting.</p>
</div>
</div>
</div>
<div id="method_NATIVES_LINKER" class="method item private">
<h3 class="name"><code>NATIVES_LINKER</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/_Users_dmp_dev_jsboot_gulp-yuidoc_node_modules_yuidocjs_lib_builder.js.html#l310"><code>/Users/dmp/dev/jsboot/gulp-yuidoc/node_modules/yuidocjs/lib/builder.js:310</code></a>
</p>
</div>
<div class="description">
<p>Function to link an external type uses <code>NATIVES</code> object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type">String</span>
<div class="param-descri