Skip to content

Commit 9f69c0a

Browse files
committed
Better doc-generation, document the doc commands
1 parent a1c9c10 commit 9f69c0a

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ Therefore, we do not recommend using this shortcut.
9797
is the included content.
9898

9999
This project uses [JSDoc](http://usejsdoc.org/). For the full public API
100-
documentation, clone the repository and run `npm run doc`. This will run JSDoc
100+
documentation, clone the repository and run `jake doc`. This will run JSDoc
101101
with the proper options and output the documentation to `out/`. If you want
102-
the both the public & private API docs, run `npm run devdoc` instead.
102+
the both the public & private API docs, run `jake devdoc` instead.
103103

104104
### Tags
105105

jakefile.js

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,18 @@ task('minify', function () {
3333
console.log('Minification completed.');
3434
});
3535

36-
desc('Generates the EJS API docs');
36+
desc('Generates the EJS API docs for the public API');
3737
task('doc', function (dev) {
3838
jake.rmRf('out');
39-
var p = dev ? '-p' : '';
40-
exec('./node_modules/.bin/jsdoc ' + p + ' -c jsdoc.json lib/* docs/jsdoc/*');
41-
console.log('Documentation generated.');
39+
exec('./node_modules/.bin/jsdoc --verbose -c jsdoc.json lib/* docs/jsdoc/*');
40+
console.log('Documentation generated in ./out.');
41+
});
42+
43+
desc('Generates the EJS API docs for the public and private API');
44+
task('devdoc', function () {
45+
jake.rmRf('out');
46+
exec('./node_modules/.bin/jsdoc --verbose -p -c jsdoc.json lib/* docs/jsdoc/*');
47+
console.log('Documentation generated in ./out.');
4248
});
4349

4450
desc('Publishes the EJS API docs');

0 commit comments

Comments
 (0)