Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
YUI Javascript Documentation Tool (setuptools version)
Python Shell
branch: master

This branch is 7 commits ahead, 913 commits behind yui:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src/yui
CHANGES
INSTALL
MANIFEST.in
README
TAGS
license.txt
setup.py

README

=======
YUI DOC
=======


yuidoc is a set of tools to generate the API documentation for the JavaScript
in the YUI library.  The docs are derived completely from JavaDoc style
comment blocks; no attempt is made to understand the javascript itself.

yuidoc requires Python 2.3+ with the following extensions:
    simplejson - for reading and writing json
    cheetah    - for generating the html docs
    pygments   - for colorizing the source

The code for yuidoc is provided under a
`BSD license <http://developer.yahoo.net/yui/license.html>`_

*   `Project home page <http://developer.yahoo.com/yui/yuidoc/>`_

*   `Source code <http://github.com/yui/yuidoc>`_

*   `Issue tracker <http://yuilibrary.com/projects/yuidoc>`_


Files:
======

README
    This file

CHANGES
    The change log

INSTALL
    Installation instructions

TAGS
    Supported tags

license.txt
    Open source license details.

src/yui/doc/bin/example.sh
    An example shell script to run both the parser and generator on a src tree

src/yui/doc/bin/example.bat
    An example batch for for DOS/Windows


Commands:
=========

yuidoc-parse
    The comment block parser.  Parses all javascript files in the the specified
    directories and outputs a single file containing a json structure of the
    parsed documentation.

yuidoc-highlight
    Colorizes the script source.

yuidoc-generate
    Reads the json output from parser.py and generates HTML docs.

yuidoc
    Wrapper for yuidoc-parse, yuidoc-highlight, and yuidoc-generate.
Something went wrong with that request. Please try again.