Mercurial > mozilla > hg > DocumentIt
comparison README.txt @ 21:10c5e6d11ef8
add notes on future directions
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Wed, 03 Aug 2011 09:53:27 -0700 |
parents | 62bd66061329 |
children | 0ce6b501f62d |
comparison
equal
deleted
inserted
replaced
20:7299c4529b41 | 21:10c5e6d11ef8 |
---|---|
1 # DocumentIt | 1 # DocumentIt |
2 | 2 |
3 Mirror documentation to https://developer.mozilla.org/en/Mozmill | 3 Mirror documentation to https://developer.mozilla.org/en/Mozmill |
4 | |
5 | |
6 ## TODO | |
7 | |
8 There are several features that would be nice to have: | |
9 | |
10 - inclusion of other files | |
11 | |
12 - inclusion of `--help` documentation | |
13 | |
14 In general the approach taken shouldn't compromise the general | |
15 approach that the documentation should be the documentation, not | |
16 pre-documentation. This may be achieved by the use of (e.g. regex) | |
17 macros. For instance: | |
18 | |
19 append(--help.*$,shell(mozmill --help)) | |
20 | |
21 | |
22 | |
23 |