Build: Add JSDoc generation (fixes eslint#1363)

suisho · Jan 24, 2015 · 6458979 · 6458979
1 parent f46d4f5
commit 6458979
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ npm-debug.log
 .DS_Store
 tmp/
 .idea
+jsdoc/
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,6 @@
 language: node_js
 node_js:
     - "0.10"
+script: "npm test && npm run docs"
 after_success:
     - npm run coveralls
diff --git a/lib/token-store.js b/lib/token-store.js
@@ -20,7 +20,7 @@ module.exports = function(tokens) {
      * Gets tokens in a given interval.
      * @param {int} start Inclusive index of the first token. 0 if negative.
      * @param {int} end Exclusive index of the last token.
-     * @returns {[Token]} Tokens in the interval.
+     * @returns {Token[]} Tokens in the interval.
      */
     function get(start, end) {
         var result = [],
@@ -70,7 +70,7 @@ module.exports = function(tokens) {
      * 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.
+     * @returns {Token[]} Array of objects representing tokens.
      */
     api.getTokensBefore = function(node, beforeCount) {
         var first = starts[node.range[0]];
@@ -91,7 +91,7 @@ module.exports = function(tokens) {
      * Gets a number of tokens that precede a given node's tokens in the token stream.
      * @param {ASTNode} node The AST node.
      * @param {int} [afterCount=0] The number of tokens after the node to retrieve.
-     * @returns {[Token]} Array of objects representing tokens.
+     * @returns {Token[]} Array of objects representing tokens.
      */
     api.getTokensAfter = function(node, afterCount) {
         var start = lastTokenIndex(node) + 1;
@@ -113,7 +113,7 @@ module.exports = function(tokens) {
      * @param {ASTNode} node The AST node.
      * @param {int} [beforeCount=0] The number of tokens before the node to retrieve.
      * @param {int} [afterCount=0] The number of tokens after the node to retrieve.
-     * @returns {[Token]} Array of objects representing tokens.
+     * @returns {Token[]} Array of objects representing tokens.
      */
     api.getTokens = function(node, beforeCount, afterCount) {
         return get(
@@ -126,7 +126,7 @@ module.exports = function(tokens) {
      * Gets the first `count` tokens of the given node's token stream.
      * @param {ASTNode} node The AST node.
      * @param {int} [count=0] The number of tokens of the node to retrieve.
-     * @returns {[Token]} Array of objects representing tokens.
+     * @returns {Token[]} Array of objects representing tokens.
      */
     api.getFirstTokens = function(node, count) {
         var first = starts[node.range[0]];
@@ -150,7 +150,7 @@ module.exports = function(tokens) {
      * Gets the last `count` tokens of the given node.
      * @param {ASTNode} node The AST node.
      * @param {int} [count=0] The number of tokens of the node to retrieve.
-     * @returns {[Token]} Array of objects representing tokens.
+     * @returns {Token[]} Array of objects representing tokens.
      */
     api.getLastTokens = function(node, count) {
         var last = lastTokenIndex(node) + 1;

diff --git a/package.json b/package.json
@@ -13,6 +13,7 @@
     "patch": "node Makefile.js patch",
     "minor": "node Makefile.js minor",
     "major": "node Makefile.js major",
+    "docs": "node Makefile.js docs",
     "gensite": "node Makefile.js gensite",
     "browserify": "node Makefile.js browserify",
     "perf": "node Makefile.js perf",
@@ -61,6 +62,7 @@
     "dateformat": "^1.0.8",
     "eslint-tester": "^0.5.0",
     "istanbul": "^0.3.5",
+    "jsdoc": "^3.3.0-beta1",
     "jsonlint": "^1.6.2",
     "mocha": "^2.1.0",
     "mocha-phantomjs": "^3.5.0",
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,3 +6,4 @@ npm-debug.log @@
     .DS_Store
     tmp/
     .idea
+    jsdoc/