Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 58 lines (39 sloc) 1.52 kb
34e0cc1 Initial revision
Adam Moore authored
1 yuidoc README
2
3 yuidoc is a set of tools to generate the API documentation for the JavaScript
4 in the YUI library. The docs are derived completely from JavaDoc style
8ced5aa 0.0.6b
Adam Moore authored
5 comment blocks; no attempt is made to understand the javascript itself.
34e0cc1 Initial revision
Adam Moore authored
6
7 The tools are written in python, and should work for version 2.3 and up.
8 To date, it has only been tested in version 2.3 on a unix system. Although
83daf1f doc update
Adam Moore authored
9 largely untested, it should work in MS windows as well.
34e0cc1 Initial revision
Adam Moore authored
10
11 The following python libraries are required:
12 simplejson - for reading and writing json
13 cheetah - for generating the html docs
8ced5aa 0.0.6b
Adam Moore authored
14 pygments - for colorizing the source
34e0cc1 Initial revision
Adam Moore authored
15
16 Files:
17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18
19 README
20 This file
21
22 CHANGES
23 The change log
24
25 INSTALL
26 Installation instructions
27
28 TAGS
29 Supported tags
30
31 TODO
32 Things that need to be done
33
8ced5aa 0.0.6b
Adam Moore authored
34 bin/yuidoc_parse.py
34e0cc1 Initial revision
Adam Moore authored
35 The comment block parser. Parses all javascript files in the the specified
36 directories and outputs a single file containing a json structure of the
37 parsed documentation.
38
8ced5aa 0.0.6b
Adam Moore authored
39 bin/yuidoc_highlight.py
40 Colorizes the script source
41
42 bin/yuidoc_generate.py
34e0cc1 Initial revision
Adam Moore authored
43 Reads the json output from parser.py and generates HTML docs.
44
8ced5aa 0.0.6b
Adam Moore authored
45 bin/yuidoc.py
bd2cb00 Module names can have hyphens. Fixed missing deprecated property in sup...
Adam Moore authored
46 wraps the calss to yuidoc_parse, yuidoc_highlight, and yuidoc_generate
8ced5aa 0.0.6b
Adam Moore authored
47
34e0cc1 Initial revision
Adam Moore authored
48 bin/example.sh
49 An example shell script to run both the parser and generator on a src tree
50
8ced5aa 0.0.6b
Adam Moore authored
51 bin/example.bat
52 An example batch for for DOS/Windows
53
34e0cc1 Initial revision
Adam Moore authored
54 ext
55 External required packages, provided for convenience
56
57
Something went wrong with that request. Please try again.