/
lib_help.js.html
193 lines (177 loc) · 8.61 KB
/
lib_help.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>lib/help.js - YUIDoc</title>
<link rel="stylesheet" href="https://yui-s.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="https://yui-s.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" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.10.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 class="file-heading">File: lib/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:
* https://github.com/yui/yuidoc/blob/master/LICENSE
*/
'use strict';
YUI.add('help', function (Y) {
/**
* Shows the help text
* @module yuidoc
* @class Help
*/
/**
* The help text to display
* @private
* @property help
* @type Array
*/
var help = [
'',
'YUI Doc generates API documentation from a modified JavaDoc syntax.',
'',
'Current version ({VERSION})',
'',
'Usage: yuidoc <options> <input path>',
'',
'Common Options:',
' -c, --config, --configfile <filename> A JSON config file to provide configuration data.',
' You can also create a yuidoc.json file and place it',
' anywhere under your source tree and YUI Doc will find it',
' and use it.',
' -e, --extension <comma sep list of file extensions> The list of file extensions to parse ',
' for api documentation. (defaults to .js)',
' -x, --exclude <comma sep list of directories> Directories to exclude from parsing ',
' (defaults to \'.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp\')',
' -v, --version Show the current YUIDoc version',
' --project-version Set the doc version for the template',
' -N, --no-color Turn off terminal colors (for automation)',
' -C, --no-code Turn off code generation (don\'t include source files in output)',
' -n, --norecurse Do not recurse directories (default is to recurse)',
' --no-sort Do not alphabetical sorting of attributes, events, methods, and properties',
' -S, --selleck Look for Selleck component data and attach to API meta data',
' -V, --view Dump the Handlebars.js view data instead of writing template files',
' -p, --parse-only Only parse the API docs and create the JSON data, do not render templates',
' -o, --outdir <directory path> Path to put the generated files (defaults to ./out)',
' -t, --themedir <directory path> Path to a custom theme directory containing Handlebars templates',
' -H, --helpers <comma separated list of paths to files> Require these file and add Handlebars helpers. See docs for more information',
' --charset CHARSET Use this as the default charset for all file operations. Defaults to \'utf8\'',
' -h, --help Show this help',
' -q, --quiet Supress logging output',
' -T, --theme <simple|default> Choose one of the built in themes (default is default)',
' --syntaxtype <js|coffee> Choose comment syntax type (default is js)',
' --server <port> Fire up the YUIDoc server for faster API doc developement. Pass optional port to listen on. (default is 3000)',
' --lint Lint your docs, will print parser warnings and exit code 1 if there are any',
'',
' <input path> Supply a list of paths (shell globbing is handy here)',
''
].join('\n');
/**
* 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 () {
console.error(Y.renderHelp());
process.exit(0); //Shouldn't exit one on help
};
});
</pre>
</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>