Closed
Description
The docs suggest this should still work: http://eslint.org/docs/developer-guide/development-environment.html
I tried running:
npm run docs
Which should have generated the docs into the jsdoc directory however nothing was produced and make file threw nothing to stdout.
I tried adding in the bindings into package.json to link the run scripts with no immediate avail as other doc files were breaking the generation:
Generating documentation
js: "/usr/local/lib/node_modules/jsdoc/jsdoc.js", line 316: exception from uncaught JavaScript throw: Error: cannot create a doclet for the comment "/** * Gets a number of tokens that precede a given node's tokens in the token stream. * @param {ASTNode} node The AST node. * @param {int} [beforeCount=0] The number of tokens before the node to retrieve. * @returns {[Token]} Array of objects representing tokens. */": unable to parse the type expression "[Token]": Expected "!", "$", "(", "*", "...", "?", "Function", "\\", "_", "break", "case", "catch", "class", "const", "continue", "debugger", "default", "delete", "do", "else", "enum", "export", "extends", "false", "finally", "for", "function", "if", "implements", "import", "in", "instanceof", "interface", "let", "new", "null", "package", "private", "protected", "public", "return", "static", "super", "switch", "this", "throw", "true", "try", "typeof", "undefined", "var", "void", "while", "with", "yield", "{", Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode titlecase letter or Unicode uppercase letter but "[" found.
I suspect the following tasks should be done:
- Add tests to make sure the functionality stays, testing both the output and the command both looks the right shape.
- Spin up a simple web head to run the docs in the browser
- Get the functionality generating the doc files again into
jsdocdirectory
Eslint version: 0.6.2 installed from master.
Willing to resolve this issue.
Activity