yui / yuidoc

YUI Javascript Documentation Tool — Read more

This URL has Read+Write access

Fixed JS Syntax error

davglass (author)

Mon Mar 01 06:51:43 -0800 2010

commit 1c76ee672e3e2f868c8c02a38cc5b75de6789bf3
tree ebc2c6d6e03e211c2b88ff1861269f5898af6d2d
parent b39ba67c2638abbfe49ad5be12386fba818a2faa

yuidoc /

name	age	history message
.gitignore	Sat May 16 13:47:59 -0700 2009	highlight handles high bit characters better. [... [apm]
CHANGES	Thu Jul 02 14:00:43 -0700 2009	Added known issues and workarounds. Identified... [apm]
INSTALL	Tue Oct 27 16:53:53 -0700 2009	Added note about easy_install failing when pull... [apm]
KNOWN_ISSUES	Thu Jul 02 18:39:14 -0700 2009	Completely refactored all io operations to elim... [apm]
README	Mon Nov 30 12:00:23 -0800 2009	Added whitespace to test builds from yuisource [sdesai]
TAGS	Mon Oct 08 11:42:58 -0700 2007	doc update [apm]
bin/	Wed Jan 06 13:10:26 -0800 2010	2009 -> 2010 [apm]
ext/	Fri Dec 05 14:58:27 -0800 2008	Updated setuptools, removed TODO, fixed errors ... [apm]
license.txt	Wed Jan 06 13:10:26 -0800 2010	2009 -> 2010 [apm]
template/	Mon Mar 01 06:51:43 -0800 2010	Fixed JS Syntax error [davglass]
test/	Wed Nov 18 12:38:22 -0800 2009	The file list for each parsed directory is sort... [apm]

README

yuidoc README

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

KNOWN_ISSUES
    Known issues and workarounds.

TAGS
    Supported tags

license.txt
    Open source license details.

bin/yuidoc_parse.py
    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.

bin/yuidoc_highlight.py
    Colorizes the script source

bin/yuidoc_generate.py
    Reads the json output from parser.py and generates HTML docs.

bin/yuidoc.py
    Wrapper for yuidoc_parse, yuidoc_highlight, and yuidoc_generate

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

bin/example.bat
    An example batch for for DOS/Windows

ext
    External required packages, provided for convenience

yui / yuidoc

Pledgie Donations