osteele / protodoc

JavaScript documentation generator and pydoc equivalent

This URL has Read+Write access

protodoc / agenda.txt
100644 51 lines (43 sloc) 1.076 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
* Next
- factor into builder
 
* Fix HTML
- record -> definition
- target -> namespace?
 
* Code cleanup
- single vs. multiline
- hoist parsing for comment types: signature
- use builders
- hoist statemachine initialiation
- parsing positions
- use package system
 
* Completion
- autoinclude Base
- test on other libraries
- docs
 
* Later
- sections are always added in the last container (fix for roll-up)
- optimize statemachine scanner
- make parsers, builders, renderers, paragraph formatter configurable
- clean up format vs. render
- pass in logger
 
* Testing
http://osteele.dev/sources/javascript/osdoc/?source=test.js
- prototype, scriptaculous, protoscript, yui, jquery, client and server-side libraries, ...
 
* Release checklist
- test in other browsers
- remove the cache-busting?
- test w/out prototype?
 
* Future
- @nodoc
- document object slots
- pluggable formatters
- pluggable comment formatters
- xml output format
- roll up class definitions
- recognize subclasses
- show inline docs
- ToC
- other parsers
- show source
- frames
- option to show all comments