diff --git a/jsdoc.js b/jsdoc.js index d1d68c83..a29cf364 100644 --- a/jsdoc.js +++ b/jsdoc.js @@ -225,7 +225,7 @@ function main() { require('jsdoc/borrow').resolveBorrows(docs); - if (env.opts.expel) { + if (env.opts.explain) { console.log(docs); exit(0); } diff --git a/rhino_modules/jsdoc/opts/parser.js b/rhino_modules/jsdoc/opts/parser.js index 4b0d30c7..8c961a96 100644 --- a/rhino_modules/jsdoc/opts/parser.js +++ b/rhino_modules/jsdoc/opts/parser.js @@ -18,14 +18,12 @@ argParser.addOption('t', 'template', true, 'The name of the template to use. Default: the "default" template'); argParser.addOption('c', 'configure', true, 'The path to the configuration file. Default: jsdoc __dirname + /conf.json'); - argParser.addOption('e', 'encoding', true, 'Assume this encoding when reading all source files. Default: your system default encoding'); - argParser.addOption('n', 'nocode', false, 'Ignore doclets that don\'t explicitly provide a symbol name.'); + argParser.addOption('e', 'encoding', true, 'Assume this encoding when reading all source files. Default: utf-8'); argParser.addOption('T', 'test', false, 'Run all tests and quit.'); argParser.addOption('d', 'destination', true, 'The path to the output folder. Use "console" to dump data to the console. Default: console'); - argParser.addOption('V', 'validate', false, 'Validate the results produced by parsing the source code.'); argParser.addOption('r', 'recurse', false, 'Recurse into subdirectories when scanning for source code files.'); argParser.addOption('h', 'help', false, 'Print this message and quit.'); - argParser.addOption('X', 'expel', false, 'Dump all found doclet internals to console and quit.'); + argParser.addOption('X', 'explain', false, 'Dump all found doclet internals to console and quit.'); argParser.addOption('q', 'query', true, 'Provide a querystring to define custom variable names/values to add to the options hash.'); diff --git a/rhino_modules/jsdoc/tag/dictionary/definitions.js b/rhino_modules/jsdoc/tag/dictionary/definitions.js index 12f2a14e..9d41f496 100644 --- a/rhino_modules/jsdoc/tag/dictionary/definitions.js +++ b/rhino_modules/jsdoc/tag/dictionary/definitions.js @@ -419,6 +419,14 @@ } }); + dictionary.defineTag('todo', { + mustHaveValue: true, + onTagged: function(doclet, tag) { + if (!doclet.todo) { doclet.todo = []; } + doclet.todo.push(tag.value); + } + }); + dictionary.defineTag('type', { mustHaveValue: true, canHaveType: true, diff --git a/templates/default/tmpl/details.tmpl b/templates/default/tmpl/details.tmpl index 17d15e30..cf3c03eb 100644 --- a/templates/default/tmpl/details.tmpl +++ b/templates/default/tmpl/details.tmpl @@ -52,4 +52,15 @@ ?> + + +