Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 59 lines (44 sloc) 2.709 kb
4087db1 @davglass README update
authored
1 YUIDoc Doc parser
2 =================
1d8cd71 @dtan adding in documentation from the python build
dtan authored
3
4087db1 @davglass README update
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
authored
11
4087db1 @davglass README update
authored
12 Current Build Status
13 --------------------
6766dd8 @davglass Added Build Status
authored
14
fdf14d5 @davglass Renaming project in various docs
authored
15 [![Build Status](https://secure.travis-ci.org/yui/yuidoc.png?branch=master)](http://travis-ci.org/yui/yuidoc)
6766dd8 @davglass Added Build Status
authored
16
4087db1 @davglass README update
authored
17 Installation
18 ------------
8fc21db @dtan trying to fix formatting
dtan authored
19
4087db1 @davglass README update
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
authored
23 Documentation
24 -------------
1d8cd71 @dtan adding in documentation from the python build
dtan authored
25
fdf14d5 @davglass Renaming project in various docs
authored
26 * [User Guides](http://yui.github.com/yuidoc/)
27 * [API Docs](http://yui.github.com/yuidoc/api/)
143aba1 @davglass Added Google Group link for support
authored
28 * [Support Mailing List](https://groups.google.com/forum/#!forum/yuidoc)
3c44380 @dtan trying to fix formatting
dtan authored
29
f02ec8b @davglass Updated the README with my thoughts
authored
30
4087db1 @davglass README update
authored
31 Released under the YUI BSD License
32 ----------------------------------
d1429b3 @davglass More License Updates
authored
33
e1a3c38 @davglass README update
authored
34 Copyright 2012 Yahoo! Inc.
35 All rights reserved.
36
37 Redistribution and use in source and binary forms, with or without
38 modification, are permitted provided that the following conditions are met:
39
40 * Redistributions of source code must retain the above copyright
41 notice, this list of conditions and the following disclaimer.
42 * Redistributions in binary form must reproduce the above copyright
43 notice, this list of conditions and the following disclaimer in the
44 documentation and/or other materials provided with the distribution.
45 * Neither the name of the Yahoo! Inc. nor the
46 names of its contributors may be used to endorse or promote products
47 derived from this software without specific prior written permission.
48
49 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
50 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
51 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
52 DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY
53 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
54 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
55 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
56 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
57 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
58 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Something went wrong with that request. Please try again.