forked from yui/yuidoc
/
lib_index.js.html
228 lines (187 loc) · 7.79 KB
/
lib_index.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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>lib/index.js - YUIDoc</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.5.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.5.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="http://yuilibrary.com/img/yui-logo.png" title="YUIDoc"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.15</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/index.js</h1>
<div class="file">
<pre class="code prettyprint linenums">
/*
Copyright (c) 2011, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://yuilibrary.com/license/
*/
/**
Module creates the YUI instance with the required modules, uses them and exports the **Y** to be used
by the _CLI class_ or by extenders: `require('yuidocjs');`
You can use it like this:
var options = {
paths: [ './lib' ],
outdir: './out'
};
var Y = require('yuidocjs');
var json = (new Y.YUIDoc(options)).run();
@class Main
@exports {YUI} Y A YUI instance
@module yuidoc
*/
var YUI = require('yui').YUI,
path = require('path'),
fs = require('graceful-fs'),
metaPath = path.join(__dirname, '../', 'package.json');
process.on('uncaughtException', function(msg) {
var inst = YUI(),
meta = JSON.parse(fs.readFileSync(metaPath));
inst.applyConfig({
debug: true,
useColor: Y.config.useColor
});
inst.log('--------------------------------------------------------------------------', 'error');
inst.log('An uncaught YUIDoc error has occurred, stack trace given below', 'error');
inst.log('--------------------------------------------------------------------------', 'error');
inst.log(msg.stack || msg.message || msg, 'error');
inst.log('--------------------------------------------------------------------------', 'error');
inst.log('Node.js version: ' + process.version, 'error');
inst.log('YUI version: ' + YUI.version, 'error');
inst.log('YUIDoc version: ' + meta.version, 'error');
inst.log('Please file all tickets here: ' + meta.bugs.url, 'error');
inst.log('--------------------------------------------------------------------------', 'error');
process.exit(1);
});
var Y = YUI({
modules: {
help: {
fullpath: path.join(__dirname, 'help.js')
},
options: {
fullpath: path.join(__dirname, 'options.js')
},
docparser: {
fullpath: path.join(__dirname, 'docparser.js'),
requires: ['base-base', 'json-stringify']
},
yuidoc: {
fullpath: path.join(__dirname, 'yuidoc.js')
},
'doc-builder': {
fullpath: path.join(__dirname, 'builder.js'),
requires: ['parallel', 'handlebars']
},
utils: {
fullpath: path.join(__dirname, 'utils.js')
},
files: {
fullpath: path.join(__dirname, 'files.js')
},
docview: {
fullpath: path.join(__dirname, 'docview.js')
},
server: {
fullpath: path.join(__dirname, 'server.js')
},
project: {
fullpath: path.join(__dirname, 'project.js')
}
},
logExclude: {
yui: true,
get: true,
files: true,
loader: true
},
useSync: true
}).use('utils', 'docparser', 'yuidoc', 'doc-builder', 'docview', 'files', 'help', 'options', 'server', 'project');
Y.packageInfo = Y.Files.getJSON(metaPath);
module.exports = Y;
</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>