-
Notifications
You must be signed in to change notification settings - Fork 211
/
index.mustache
87 lines (76 loc) · 2.71 KB
/
index.mustache
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
<h2>Welcome to YUIDoc {{version}}!</h2>
<div class="intro">
<p>YUIDoc is a <a href="http://nodejs.org/">Node.js</a> application that
generates API documentation from comments in source, using a syntax similar
to tools like Javadoc and Doxygen. YUIDoc provides:</p>
<ul>
<li><b>Live previews.</b> YUIDoc includes a
<a href="args/index.html#server">standalone doc server</a>,
making it trivial to preview your docs as you write.</li>
<li><b>Modern markup.</b> YUIDoc's generated documentation is an
<a href="http://yuilibrary.com/yui/docs/api/classes/Model.html">attractive,
functional web application</a> with real URLs and graceful
fallbacks for spiders and other agents that can't run JavaScript.</li>
<li><b>Wide language support.</b> YUIDoc was originally designed for
the <a href="http://yuilibrary.com">YUI project</a>, but it is not
tied to any particular library or programming language.
You can use it with any language that supports
`/* */` comment blocks.</li>
</ul>
</p>
</div>
<h2 id="#install">Installation and Usage</h2>
<ol>
<li>Download and install <a href="http://nodejs.org/#download">Node.js</a></li>
<li>Run `npm -g install yuidocjs`.</li>
<li>Run `yuidoc .` at the top of your JS source tree.</li>
</ol>
<p>That's it! For more information about running the `yuidoc` commandline tool,
refer to "<a href="args/index.html">Using YUIDoc</a>".</p>
<h2>User Guides</h2>
<ul>
{{#components}}
{{#meta}}
<li><a href="{{name}}/index.html">{{displayName}}</a> — {{description}}</li>
{{/meta}}
{{/components}}
</ul>
<h2>Example YUIDoc Comment Blocks</h2>
<p>YUIDoc parses a modified form of JSDoc tags.
This section provides a taste of some of the more common constructs in YUIDoc.
For more information, refer to the "<a href="./syntax/index.html">YUIDoc Syntax Reference</a>".</p>
<h3>Example Class Block</h3>
```
/**
* This is the description for my class.
*
* @class MyClass
* @constructor
*/
```
<h3>Example Method Block</h3>
```
/**
* My method description. Like other pieces of your comment blocks,
* this can span multiple lines.
*
* @method methodName
* @param {String} foo Argument 1
* @param {Object} config A config object
* @param {String} config.name The name on the config object
* @param {Function} config.callback A callback function on the config object
* @param {Boolean} [extra=false] Do extra, optional work
* @return {Boolean} Returns true on success
*/
```
<h3>Example Property Block</h3>
```
/**
* My property description. Like other pieces of your comment blocks,
* this can span multiple lines.
*
* @property propertyName
* @type {Object}
* @default "foo"
*/
```