Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

209 lines (175 sloc) 8.374 kb
<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8">
<title>lib&#x2F;help.js - YUIDoc</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
<script src="http:&#x2F;&#x2F;;combo?3.8.0&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="http:&#x2F;&#x2F;;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.36</em>
<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>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
<li><a href="..&#x2F;classes/DocParser.html">DocParser</a></li>
<li><a href="..&#x2F;classes/DocView.html">DocView</a></li>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
<li><a href="..&#x2F;classes/Help.html">Help</a></li>
<li><a href="..&#x2F;classes/Main.html">Main</a></li>
<li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
<li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
<ul id="api-modules" class="apis modules">
<li><a href="..&#x2F;modules/yuidoc.html">yuidoc</a></li>
<div class="yui3-u-3-4">
<div id="api-options">
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1 class="file-heading">File: lib&#x2F;help.js</h1>
<div class="file">
<pre class="code prettyprint linenums">
Copyright (c) 2011, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
YUI.add(&#x27;help&#x27;, function(Y) {
* Shows the help text
* @module yuidoc
* @class Help
* The help text to display
* @private
* @property help
* @type Array
var help = [
&quot;YUI Doc generates API documentation from a modified JavaDoc syntax.&quot;,
&quot;Current version ({VERSION})&quot;,
&quot;Usage: yuidoc &lt;options&gt; &lt;input path&gt;&quot;,
&quot;Common Options:&quot;,
&quot; -c, --config, --configfile &lt;filename&gt; A JSON config file to provide configuration data.&quot;,
&quot; You can also create a yuidoc.json file and place it&quot;,
&quot; anywhere under your source tree and YUI Doc will find it&quot;,
&quot; and use it.&quot;,
&quot; -e, --extension &lt;comma sep list of file extensions&gt; The list of file extensions to parse &quot;,
&quot; for api documentation. (defaults to .js)&quot;,
&quot; -x, --exclude &lt;comma sep list of directories&gt; Directories to exclude from parsing &quot;,
&quot; (defaults to &#x27;.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp&#x27;)&quot;,
&quot; -v, --version Show the current YUIDoc version&quot;,
&quot; --project-version Set the doc version for the template&quot;,
&quot; -N, --no-color Turn off terminal colors (for automation)&quot;,
&quot; -C, --no-code Turn off code generation (don&#x27;t include source files in output)&quot;,
&quot; -n, --norecurse Do not recurse directories (default is to recurse)&quot;,
&quot; -S, --selleck Look for Selleck component data and attach to API meta data&quot;,
&quot; -V, --view Dump the Handlebars.js view data instead of writing template files&quot;,
&quot; -p, --parse-only Only parse the API docs and create the JSON data, do not render templates&quot;,
&quot; -o, --out &lt;directory path&gt; Path to put the generated files (defaults to .&#x2F;out)&quot;,
&quot; -t, --themedir &lt;directory path&gt; Path to a custom theme directory containing Handlebars templates&quot;,
&quot; -H, --helpers &lt;comma separated list of paths to files&gt; Require these file and add Handlebars helpers. See docs for more information&quot;,
&quot; --charset CHARSET Use this as the default charset for all file operations. Defaults to &#x27;utf8&#x27;&quot;,
&quot; -h, --help Show this help&quot;,
&quot; -q, --quiet Supress logging output&quot;,
&quot; -T, --theme &lt;simple|default&gt; Choose one of the built in themes (default is default)&quot;,
&quot; --syntaxtype &lt;js|coffee&gt; Choose comment syntax type (default is js)&quot;,
&quot; --server &lt;port&gt; Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)&quot;,
&quot; --lint Lint your docs, will print parser warnings and exit code 1 if there are any&quot;,
&quot; &lt;input path&gt; Supply a list of paths (shell globbing is handy here)&quot;,
* Render the help message as a string
* @method renderHelp
* @return {String} The help screen to display
Y.renderHelp = function() {
return Y.Lang.sub(help, {
VERSION: Y.packageInfo.version
* Display the help message, write it to the screen and exit
* @method showHelp
Y.showHelp = function() {
process.exit(0); &#x2F;&#x2F;Shouldn&#x27;t exit one on help
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
Jump to Line
Something went wrong with that request. Please try again.