diff --git a/.gitignore b/.gitignore index e434b89..2319f4d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ /bin /coverage -/esdoc +/jsdoc /lib /node_modules /npm-debug.log diff --git a/docs/node-api.md b/docs/node-api.md index 865453c..cb283ce 100644 --- a/docs/node-api.md +++ b/docs/node-api.md @@ -68,5 +68,3 @@ Run npm-scripts. `runAll` returns a promise that will becomes *fulfilled* when all scripts are completed. The promise will become *rejected* when any of the scripts exit with a non-zero code. - -See also: https://doc.esdoc.org/github.com/mysticatea/npm-run-all/ diff --git a/esdoc.json b/esdoc.json deleted file mode 100644 index 0f1ec18..0000000 --- a/esdoc.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "source": "src", - "destination": "esdoc", - "access": ["public", "protected", "private"], - "plugins": [ - { - "name": "esdoc-importpath-plugin", - "option": { - "replaces": [{"from": "^src/", "to": ""}] - } - } - ] -} diff --git a/jsdoc.json b/jsdoc.json new file mode 100644 index 0000000..d813cdb --- /dev/null +++ b/jsdoc.json @@ -0,0 +1,10 @@ +{ + "source": { + "include": ["src/lib", "README.md"] + }, + "opts": { + "destination": "jsdoc", + "encoding": "utf8", + "recurse": true + } +} diff --git a/package.json b/package.json index 6ad83b9..4372e98 100644 --- a/package.json +++ b/package.json @@ -20,11 +20,11 @@ "preversion": "npm run build", "postversion": "git push && git push --tags", "pretest": "node scripts/make-slink.js", - "clean": "rimraf bin coverage docs lib", + "clean": "rimraf bin coverage esdoc lib", "lint": "eslint src test \"test-workspace/tasks/*\"", "build": "babel-node src/bin/run-s/index.js clean lint build:*", "build:babel": "babel src --out-dir .", - "build:esdoc": "esdoc -c esdoc.json", + "build:jsdoc": "jsdoc -c jsdoc.json", "test": "npm run lint && babel-node node_modules/isparta/bin/isparta cover node_modules/mocha/bin/_mocha -- test/*.js --timeout 60000", "watch": "mocha test/*.js --require babel-register --timeout 60000 --watch --growl", "coveralls": "cat coverage/lcov.info | coveralls" @@ -49,11 +49,10 @@ "babel-preset-es2015": "^6.3.13", "babel-register": "^6.4.3", "coveralls": "^2.11.4", - "esdoc": "^0.4.3", - "esdoc-importpath-plugin": "^0.0.1", "eslint": "^2.9.0", "eslint-config-mysticatea": "^3.0.0", "isparta": "^4.0.0", + "jsdoc": "^3.4.0", "mocha": "^2.3.4", "power-assert": "^1.2.0", "rimraf": "^2.4.4" diff --git a/src/lib/create-header.js b/src/lib/create-header.js index 9387872..a15bc6b 100644 --- a/src/lib/create-header.js +++ b/src/lib/create-header.js @@ -1,4 +1,5 @@ /** + * @module create-header * @author Toru Nagashima * @copyright 2016 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/create-prefix-transform-stream.js b/src/lib/create-prefix-transform-stream.js index 1641a0f..25555e2 100644 --- a/src/lib/create-prefix-transform-stream.js +++ b/src/lib/create-prefix-transform-stream.js @@ -1,4 +1,5 @@ /** + * @module create-prefix-transform-stream * @author Toru Nagashima * @copyright 2016 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/index.js b/src/lib/index.js index 4739a68..aef40f8 100644 --- a/src/lib/index.js +++ b/src/lib/index.js @@ -1,4 +1,5 @@ /** + * @module index * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/match-tasks.js b/src/lib/match-tasks.js index 9947fe3..cc2e0a5 100644 --- a/src/lib/match-tasks.js +++ b/src/lib/match-tasks.js @@ -1,4 +1,5 @@ /** + * @module match-tasks * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/read-package-json.js b/src/lib/read-package-json.js index 04e0c42..a343276 100644 --- a/src/lib/read-package-json.js +++ b/src/lib/read-package-json.js @@ -1,4 +1,5 @@ /** + * @module read-package-json * @author Toru Nagashima * @copyright 2016 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/run-task.js b/src/lib/run-task.js index 56428d2..040d44f 100644 --- a/src/lib/run-task.js +++ b/src/lib/run-task.js @@ -1,4 +1,5 @@ /** + * @module run-task * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/run-tasks-in-parallel.js b/src/lib/run-tasks-in-parallel.js index 27e26f0..eebde06 100644 --- a/src/lib/run-tasks-in-parallel.js +++ b/src/lib/run-tasks-in-parallel.js @@ -1,4 +1,5 @@ /** + * @module run-tasks-in-parallel * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/run-tasks-in-sequencial.js b/src/lib/run-tasks-in-sequencial.js index 830b500..bfec46e 100644 --- a/src/lib/run-tasks-in-sequencial.js +++ b/src/lib/run-tasks-in-sequencial.js @@ -1,4 +1,5 @@ /** + * @module run-tasks-in-sequencial * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/spawn-posix.js b/src/lib/spawn-posix.js index 7a39e62..edeab60 100644 --- a/src/lib/spawn-posix.js +++ b/src/lib/spawn-posix.js @@ -1,4 +1,5 @@ /** + * @module spawn-posix * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/spawn-win32.js b/src/lib/spawn-win32.js index bfa7a48..0fdbac5 100644 --- a/src/lib/spawn-win32.js +++ b/src/lib/spawn-win32.js @@ -1,4 +1,5 @@ /** + * @module spawn-win32 * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license. diff --git a/src/lib/spawn.js b/src/lib/spawn.js index a972110..2227b19 100644 --- a/src/lib/spawn.js +++ b/src/lib/spawn.js @@ -1,4 +1,5 @@ /** + * @module spawn * @author Toru Nagashima * @copyright 2015 Toru Nagashima. All rights reserved. * See LICENSE file in root directory for full license.