Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 58 lines (43 sloc) 2.661 kb
4087db1 @davglass README update
davglass authored
1 YUIDoc Doc parser
2 =================
1d8cd71 @dtan adding in documentation from the python build
dtan authored
3
4087db1 @davglass README update
davglass authored
4 YUIDoc is a [Node.js](http://nodejs.org/) application used at build time to
5 generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide
6 range of JavaScript coding styles. The output of YUI Doc is API documentation formatted as a
7 set of HTML pages including information about methods, properties, custom events and
8 inheritance for JavaScript objects. YUIDoc was orignally written for the YUI Project;
9 it uses YUI JavaScript and CSS in the generated files and it supports common YUI
10 conventions like Custom Events. That said, it can be used easily and productively on non-YUI code.
071e2ad @davglass README update
davglass authored
11
4087db1 @davglass README update
davglass authored
12 Current Build Status
13 --------------------
6766dd8 @davglass Added Build Status
davglass authored
14
15 [![Build Status](https://secure.travis-ci.org/davglass/yuidocjs.png?branch=master)](http://travis-ci.org/davglass/yuidocjs)
16
4087db1 @davglass README update
davglass authored
17 Installation
18 ------------
8fc21db @dtan trying to fix formatting
dtan authored
19
4087db1 @davglass README update
davglass authored
20 npm -g i yuidocjs
29e1f73 @dtan trying to fix formatting
dtan authored
21
8fc21db @dtan trying to fix formatting
dtan authored
22
4087db1 @davglass README update
davglass authored
23 Documentation
24 -------------
1d8cd71 @dtan adding in documentation from the python build
dtan authored
25
4087db1 @davglass README update
davglass authored
26 * [User Guides](http://davglass.github.com/yuidocjs/)
27 * [API Docs](http://davglass.github.com/yuidocjs/api/)
3c44380 @dtan trying to fix formatting
dtan authored
28
f02ec8b @davglass Updated the README with my thoughts
davglass authored
29
4087db1 @davglass README update
davglass authored
30 Released under the YUI BSD License
31 ----------------------------------
d1429b3 @davglass More License Updates
davglass authored
32
e1a3c38 @davglass README update
davglass authored
33 Copyright 2012 Yahoo! Inc.
34 All rights reserved.
35
36 Redistribution and use in source and binary forms, with or without
37 modification, are permitted provided that the following conditions are met:
38
39 * Redistributions of source code must retain the above copyright
40 notice, this list of conditions and the following disclaimer.
41 * Redistributions in binary form must reproduce the above copyright
42 notice, this list of conditions and the following disclaimer in the
43 documentation and/or other materials provided with the distribution.
44 * Neither the name of the Yahoo! Inc. nor the
45 names of its contributors may be used to endorse or promote products
46 derived from this software without specific prior written permission.
47
48 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
49 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
50 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
51 DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY
52 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
53 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
54 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
55 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
57 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Something went wrong with that request. Please try again.