Skip to content
Newer
Older
100644 41 lines (26 sloc) 1.37 KB
f02ec8b @davglass Updated the README with my thoughts
davglass authored Nov 30, 2010
1 # YUIDoc Doc parser
3ebaa95 Initial revision.
Adam Moore authored Nov 24, 2010
2
f02ec8b @davglass Updated the README with my thoughts
davglass authored Nov 30, 2010
3 Updated yuidoc parser, written in js -- *early work in progress*
3ebaa95 Initial revision.
Adam Moore authored Nov 24, 2010
4
f02ec8b @davglass Updated the README with my thoughts
davglass authored Nov 30, 2010
5 ## Usage
3ebaa95 Initial revision.
Adam Moore authored Nov 24, 2010
6
f02ec8b @davglass Updated the README with my thoughts
davglass authored Nov 30, 2010
7 lib/yuidoc.js ../yui3/src
3ebaa95 Initial revision.
Adam Moore authored Nov 24, 2010
8
f02ec8b @davglass Updated the README with my thoughts
davglass authored Nov 30, 2010
9 This will produce a data structure in `out/data.json` by default.
3ebaa95 Initial revision.
Adam Moore authored Nov 24, 2010
10
f02ec8b @davglass Updated the README with my thoughts
davglass authored Nov 30, 2010
11
12 ## Dav's Thoughts:
13
14
15 ### Out dir formatting
16
17 Setting up the directory structure like this will help us build a nice templating system on
18 top of this data. It will give us the ability to include just part of the structure. It will
19 also help up when building the new YUILibrary.com site and importing all this data into MongoDB.
20
21 `./out` needs to look like this instead:
22 ./out/
23 data.json //Rollup of all metadata
24 module1/
25 data.json //metadata for only this module
26 module2/
27 data.json
28
29 ### Parse only what we need to parse.
30
31 Keep a *state* file somewhere that shows the last time this doc tree was parsed
32 This way, we can do a stat on the file to see if it's mtime is greater than the
33 last parse time and only parse it if it is. This will allow us, in the future, to not reparse files
34 that have not changed. It should speed up the parse process for a large file set.
35
36 ### Module Structure
37
38 I moved docparser into a module of it's own. The YUIDoc module should also be a standalone module.
39 We should make `cli.js` instantiate that class and run it. We also need to add a way to `export`
40 these modules so they can be *required* in a script and coded against.
Something went wrong with that request. Please try again.