Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 189 lines (149 sloc) 6.613 kb
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="utf-8">
3a37f14 @davglass Updated API docs
davglass authored
5 <title>YUIDoc - Javascript Documentation Tool</title>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
6 <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Maven+Pro:400,700">
7 <link rel="stylesheet" href="http://yui.yahooapis.com/3.4.1/build/cssgrids/grids-min.css">
8 <link rel="stylesheet" href="assets/css/main.css">
9 <link rel="stylesheet" href="assets/vendor/prettify/prettify-min.css">
c0c38bb @davglass Added favicon to default theme
davglass authored
10 <link rel="shortcut icon" type="image/png" href="assets/favicon.png">
9d37046 @davglass Doc Updates
davglass authored
11 <script src="http://yui.yahooapis.com/3.5.1/build/yui/yui.js"></script>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
12 </head>
13 <body>
d7fb88e @davglass Doc Build
davglass authored
14 <a href="https://github.com/yui/yuidoc"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
15 <div id="doc">
c13d517 @davglass Doc Updates
davglass authored
16 <div id="hd">
17 <h1><img src="http://yuilibrary.com/img/yui-logo.png">YUIDoc - Javascript Documentation Tool</h1>
18 </div>
46be362 @davglass Rendered Docs Update
davglass authored
19
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
20
21 <a href="#toc" class="jump">Jump to Table of Contents</a>
22
23
24 <div class="yui3-g">
25 <div class="yui3-u-3-4">
26 <div id="main">
b264323 @davglass Docs
davglass authored
27 <div class="content"><h2 id="welcome-to-yuidoc-0328">Welcome to YUIDoc 0.3.28!</h2>
8046d17 @davglass Deploy docs updated
davglass authored
28
29 <div class="intro">
30 <p>YUIDoc is a <a href="http://nodejs.org/">Node.js</a> application that
31 generates API documentation from comments in source, using a syntax similar
32 to tools like Javadoc and Doxygen. YUIDoc provides:</p>
33
34 <ul>
35 <li><b>Live previews.</b> YUIDoc includes a
4f176eb @davglass Doc Generation
davglass authored
36 <a href="args/index.html#server">standalone doc server</a>,
8046d17 @davglass Deploy docs updated
davglass authored
37 making it trivial to preview your docs as you write.</li>
38 <li><b>Modern markup.</b> YUIDoc's generated documentation is an
39 <a href="http://yuilibrary.com/yui/docs/api/classes/Model.html">attractive,
40 functional web application</a> with real URLs and graceful
41 fallbacks for spiders and other agents that can't run JavaScript.</li>
42 <li><b>Wide language support.</b> YUIDoc was originally designed for
308288a @davglass Doc Tweak
davglass authored
43 the <a href="http://yuilibrary.com">YUI project</a>, but it is not
8046d17 @davglass Deploy docs updated
davglass authored
44 tied to any particular library or programming language.
45 You can use it with any language that supports
46 <code>&#x2F;* *&#x2F;</code> comment blocks.</li>
47 </ul>
7a372e9 @davglass Rendered Doc Updates
davglass authored
48 </p>
8046d17 @davglass Deploy docs updated
davglass authored
49 </div>
7a372e9 @davglass Rendered Doc Updates
davglass authored
50
8046d17 @davglass Deploy docs updated
davglass authored
51 <h2 id="#install">Installation and Usage</h2>
7a372e9 @davglass Rendered Doc Updates
davglass authored
52
8046d17 @davglass Deploy docs updated
davglass authored
53 <ol>
54 <li>Download and install <a href="http://nodejs.org/#download">Node.js</a></li>
55 <li>Run <code>npm -g install yuidocjs</code>.</li>
8816fbe @davglass Doc Updates
davglass authored
56 <li>Run <code>yuidoc .</code> at the top of your JS source tree.</li>
8046d17 @davglass Deploy docs updated
davglass authored
57 </ol>
7a372e9 @davglass Rendered Doc Updates
davglass authored
58
8046d17 @davglass Deploy docs updated
davglass authored
59 <p>That's it! For more information about running the <code>yuidoc</code> commandline tool,
4f176eb @davglass Doc Generation
davglass authored
60 refer to "<a href="args/index.html">Using YUIDoc</a>".</p>
7a372e9 @davglass Rendered Doc Updates
davglass authored
61
3a37f14 @davglass Updated API docs
davglass authored
62 <h2 id="user-guides">User Guides</h2>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
63
64 <ul>
65
66
4f176eb @davglass Doc Generation
davglass authored
67 <li><a href="args/index.html">Using YUIDoc</a> &mdash; Understanding YUIDoc command line arguments and usage.</li>
3a37f14 @davglass Updated API docs
davglass authored
68
69
70
4f176eb @davglass Doc Generation
davglass authored
71 <li><a href="syntax/index.html">YUIDoc Syntax Reference</a> &mdash; Detailed instructions for writing YUIDoc comment blocks.</li>
3a37f14 @davglass Updated API docs
davglass authored
72
73
74
4f176eb @davglass Doc Generation
davglass authored
75 <li><a href="themes/index.html">YUIDoc Themes</a> &mdash; How to modify the default YUIDoc theme.</li>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
76
77
78 </ul>
8046d17 @davglass Deploy docs updated
davglass authored
79
80 <h2 id="example-yuidoc-comment-blocks">Example YUIDoc Comment Blocks</h2>
81
4f176eb @davglass Doc Generation
davglass authored
82 <p>YUIDoc parses a modified form of JSDoc tags.
83 This section provides a taste of some of the more common constructs in YUIDoc.
8046d17 @davglass Deploy docs updated
davglass authored
84 For more information, refer to the "<a href="./syntax/index.html">YUIDoc Syntax Reference</a>".</p>
85
86 <h3 id="example-class-block">Example Class Block</h3>
87 <pre class="code prettyprint">&#x2F;**
88 * This is the description for my class.
89 *
90 * @class MyClass
91 * @constructor
92 *&#x2F;</pre>
93
94 <h3 id="example-method-block">Example Method Block</h3>
95 <pre class="code prettyprint">&#x2F;**
96 * My method description. Like other pieces of your comment blocks,
97 * this can span multiple lines.
98 *
99 * @method methodName
100 * @param {String} foo Argument 1
101 * @param {Object} config A config object
102 * @param {String} config.name The name on the config object
103 * @param {Function} config.callback A callback function on the config object
104 * @param {Boolean} [extra=false] Do extra, optional work
105 * @return {Boolean} Returns true on success
106 *&#x2F;</pre>
107
108
109 <h3 id="example-property-block">Example Property Block</h3>
110 <pre class="code prettyprint">&#x2F;**
111 * My property description. Like other pieces of your comment blocks,
112 * this can span multiple lines.
113 *
114 * @property propertyName
115 * @type {Object}
116 * @default &quot;foo&quot;
117 *&#x2F;</pre>
118
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
119 </div>
120 </div>
121 </div>
122
123 <div class="yui3-u-1-4">
124 <div class="sidebar">
c13d517 @davglass Doc Updates
davglass authored
125 <ul class="links">
126 <li><a href="https://github.com/yui/yuidoc/" class="button">Get the Source</a></li>
127 <li><a href="https://groups.google.com/forum/#!forum/yuidoc" class="button">Questions? Join the Mailing List</a></li>
128 <li><a href="https://github.com/yui/yuidoc/issues/" class="button">File an Issue</a></li>
129 <li><a href="api/" class="button">View API Documentation</a></li>
130 </ul>
8fbc5d5 @davglass Added Build Status Image
davglass authored
131 <div class="sidebox">
132 <div class="hd">
133 <h2 class="no-toc">Build Status</h2>
134 </div>
135
136 <div class="bd">
137 <a href="http://travis-ci.org/yui/yuidoc"><img src="https://secure.travis-ci.org/yui/yuidoc.png?branch=master" border="0"></a>
138 </div>
139 </div>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
140
141 <div id="toc" class="sidebox">
142 <div class="hd">
143 <h2 class="no-toc">Table of Contents</h2>
144 </div>
145
146 <div class="bd">
147 <ul class="toc">
148 <li>
b264323 @davglass Docs
davglass authored
149 <a href="#welcome-to-yuidoc-0328">Welcome to YUIDoc 0.3.28!</a>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
150 </li>
151 <li>
8046d17 @davglass Deploy docs updated
davglass authored
152 <a href="##install">Installation and Usage</a>
7a372e9 @davglass Rendered Doc Updates
davglass authored
153 </li>
154 <li>
3a37f14 @davglass Updated API docs
davglass authored
155 <a href="#user-guides">User Guides</a>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
156 </li>
8046d17 @davglass Deploy docs updated
davglass authored
157 <li>
158 <a href="#example-yuidoc-comment-blocks">Example YUIDoc Comment Blocks</a>
159 <ul class="toc">
160 <li>
161 <a href="#example-class-block">Example Class Block</a>
162 </li>
163 <li>
164 <a href="#example-method-block">Example Method Block</a>
165 </li>
166 <li>
167 <a href="#example-property-block">Example Property Block</a>
168 </li>
169 </ul>
170 </li>
e0fafc3 @davglass Reoriganizing docs, now using Selleck for docs/examples
davglass authored
171 </ul>
172 </div>
173 </div>
174
175
176
177
178
179 </div>
180 </div>
181 </div>
182 </div>
183
184 <script src="assets/vendor/prettify/prettify-min.js"></script>
185 <script>prettyPrint();</script>
186
187 </body>
188 </html>
Something went wrong with that request. Please try again.