yuidoc-asp
Version:
YUIDoc, YUI's JavaScript Documentation engine tweaked to work with VB/VBScript comments.
875 lines (537 loc) • 29.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>YUIDoc - yuidoc-root</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="icon" href="../assets/favicon.ico">
<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="yuidoc-root" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.6.0</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>YUIDoc Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_yuidoc.js.html#l49"><code>lib/yuidoc.js:49</code></a>
</div>
Module: <a href="../modules/yuidoc.html">yuidoc</a>
</div>
<div class="box intro">
<p>YUIDoc main class</p>
<pre class="code prettyprint"><code> var options = {
paths: [ './lib' ],
outdir: './out'
};
var Y = require('yuidoc');
var json = (new Y.YUIDoc(options)).run();</code></pre>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_YUIDoc" class="method item">
<h3 class="name"><code>YUIDoc</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l49"><code>lib/yuidoc.js:49</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The config object</p>
</div>
</li>
</ul>
</div>
</div>
</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 private">
<a href="#method__processConfig">_processConfig</a>
</li>
<li class="index-item method private">
<a href="#method__setDefaultExcludes">_setDefaultExcludes</a>
</li>
<li class="index-item method private">
<a href="#method_parsedir">parsedir</a>
</li>
<li class="index-item method private">
<a href="#method_parsefiles">parsefiles</a>
</li>
<li class="index-item method">
<a href="#method_run">run</a>
</li>
<li class="index-item method private">
<a href="#method_runPreprocessors">runPreprocessors</a>
</li>
<li class="index-item method private">
<a href="#method_walk">walk</a>
</li>
<li class="index-item method private">
<a href="#method_writeJSON">writeJSON</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_dirmap">dirmap</a>
</li>
<li class="index-item property">
<a href="#property_endtime">endtime</a>
</li>
<li class="index-item property private">
<a href="#property_filecount">filecount</a>
</li>
<li class="index-item property private">
<a href="#property_filemap">filemap</a>
</li>
<li class="index-item property">
<a href="#property_OPTIONS">OPTIONS</a>
</li>
<li class="index-item property private">
<a href="#property_options">options</a>
</li>
<li class="index-item property private">
<a href="#property_selleck">selleck</a>
</li>
<li class="index-item property">
<a href="#property_starttime">starttime</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__processConfig" class="method item private">
<h3 class="name"><code>_processConfig</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l127"><code>lib/yuidoc.js:127</code></a>
</p>
</div>
<div class="description">
<p>Does post process on self.options.</p>
</div>
</div>
<div id="method__setDefaultExcludes" class="method item private">
<h3 class="name"><code>_setDefaultExcludes</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l112"><code>lib/yuidoc.js:112</code></a>
</p>
</div>
<div class="description">
<p>Always exclude these directories</p>
</div>
</div>
<div id="method_parsedir" class="method item private">
<h3 class="name"><code>parsedir</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dir</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l149"><code>lib/yuidoc.js:149</code></a>
</p>
</div>
<div class="description">
<p>Walks the passed directory and grabs all the files recursively.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dir</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The directory to parse the contents of.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_parsefiles" class="method item private">
<h3 class="name"><code>parsefiles</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dir</code>
</li>
<li class="arg">
<code>files</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l190"><code>lib/yuidoc.js:190</code></a>
</p>
</div>
<div class="description">
<p>Gathers all the file data and populates the filemap and dirmap hashes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dir</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The directory to start from.</p>
</div>
</li>
<li class="param">
<code class="param-name">files</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>
<div class="param-description">
<p>List of files to parse.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_run" class="method item">
<h3 class="name"><code>run</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l376"><code>lib/yuidoc.js:376</code></a>
</p>
</div>
<div class="description">
<p>Process the config, walk the file tree and write out the JSON data.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
<p>The JSON data returned from the DocParser</p>
</div>
</div>
</div>
<div id="method_runPreprocessors" class="method item private">
<h3 class="name"><code>runPreprocessors</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l248"><code>lib/yuidoc.js:248</code></a>
</p>
</div>
<div class="description">
<p>Applies preprocessors to the data tree.
This function first clones the data and operates on the clone.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
<p>The mutated data</p>
</div>
</div>
</div>
<div id="method_walk" class="method item private">
<h3 class="name"><code>walk</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l138"><code>lib/yuidoc.js:138</code></a>
</p>
</div>
<div class="description">
<p>Walks the paths and parses the directory contents</p>
</div>
</div>
<div id="method_writeJSON" class="method item private">
<h3 class="name"><code>writeJSON</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parser</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l287"><code>lib/yuidoc.js:287</code></a>
</p>
</div>
<div class="description">
<p>Writes the parser JSON data to disk.
Applies preprocessors, if any.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parser</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<div class="param-description">
<p>The DocParser instance to use</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>:
<p>The JSON data returned from the DocParser</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_dirmap" class="property item private">
<h3 class="name"><code>dirmap</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l87"><code>lib/yuidoc.js:87</code></a>
</p>
</div>
<div class="description">
<p>Holder for the list of directories we are processing.</p>
</div>
</div>
<div id="property_endtime" class="property item">
<h3 class="name"><code>endtime</code></h3>
<span class="type">Timestamp</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l404"><code>lib/yuidoc.js:404</code></a>
</p>
</div>
<div class="description">
<p>Timestamp holder so we know when YUIDoc has finished the parse process.</p>
</div>
</div>
<div id="property_filecount" class="property item private">
<h3 class="name"><code>filecount</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l66"><code>lib/yuidoc.js:66</code></a>
</p>
</div>
<div class="description">
<p>Holds the number of files that we are processing.</p>
</div>
</div>
<div id="property_filemap" class="property item private">
<h3 class="name"><code>filemap</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l80"><code>lib/yuidoc.js:80</code></a>
</p>
</div>
<div class="description">
<p>Holder for the list of files we are processing.</p>
</div>
</div>
<div id="property_OPTIONS" class="property item">
<h3 class="name"><code>OPTIONS</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag final">final</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l29"><code>lib/yuidoc.js:29</code></a>
</p>
</div>
<div class="description">
<p>The default list of configuration options</p>
</div>
</div>
<div id="property_options" class="property item private">
<h3 class="name"><code>options</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l95"><code>lib/yuidoc.js:95</code></a>
</p>
</div>
<div class="description">
<p>Internal holder for configuration options.</p>
</div>
</div>
<div id="property_selleck" class="property item private">
<h3 class="name"><code>selleck</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l73"><code>lib/yuidoc.js:73</code></a>
</p>
</div>
<div class="description">
<p>Hash map of dirnames to selleck config options.</p>
</div>
</div>
<div id="property_starttime" class="property item">
<h3 class="name"><code>starttime</code></h3>
<span class="type">Timestamp</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_yuidoc.js.html#l382"><code>lib/yuidoc.js:382</code></a>
</p>
</div>
<div class="description">
<p>Timestamp holder so we know when YUIDoc started the parse process.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>