doc: Replace JSDuck v5.3.4 with JSDoc v3.4.3

JSDoc can handle ES2015 modules whereas JSDuck can't. Regardless of
however many features JSDuck has that JSDoc mightn't [0], we can't
use JSDuck to document this codebase.

[0] T138401

Bug: T158236
Change-Id: I8da712075dd28f6b228c96fa9577ca39eb148fb5
This commit is contained in:
Sam Smith 2017-05-19 12:28:35 +01:00
parent 9e16a03456
commit d9db2eb9a2
4 changed files with 19 additions and 7 deletions

View file

@ -1,7 +1,6 @@
source 'https://rubygems.org'
gem 'chunky_png', '~> 1.3.4'
gem 'jsduck', '~> 5.3.4'
gem 'mediawiki_selenium', '~> 1.7', '>= 1.7.1'
gem 'rake', '~> 10.4', '>= 10.4.2'
gem 'rubocop', '~> 0.29.1', require: false

17
jsdoc.json Normal file
View file

@ -0,0 +1,17 @@
{
"source": {
"include": [
"src/"
]
},
"opts": {
"destination": "docs/",
"recurse": true
},
"plugins": [
"plugins/markdown"
],
"tags": {
"allowUnknownTags": false
}
}

View file

@ -1,5 +0,0 @@
{
"--title": "Hovercards - Documentation",
"--output": "docs",
"--": ["resources"]
}

View file

@ -6,7 +6,7 @@
"test:node": "mw-node-qunit tests/node-qunit/*.js tests/node-qunit/**/*.js | tap-dot",
"test:dev": "grunt lint && npm run test:node",
"test": " npm run check-built-assets && npm run test:dev",
"doc": "jsduck",
"doc": "jsdoc -c jsdoc.json",
"check-built-assets": "echo 'CHECKING BUILD SOURCES ARE COMMITED' && rm -rf test-build && mv resources/dist test-build && npm run build && diff -x '*.map' -r test-build resources/dist && rm -rf test-build",
"coverage": "istanbul cover node_modules/.bin/mw-node-qunit tests/node-qunit/*.js tests/node-qunit/**/*.js",
"precommit": "npm run test:dev && npm run build && git add resources/dist"
@ -22,6 +22,7 @@
"grunt-stylelint": "^0.6.0",
"husky": "^0.13.3",
"istanbul": "^0.4.5",
"jsdoc": "^3.4.3",
"mock-require": "^2.0.1",
"mw-node-qunit": "^1.0.6",
"redux": "3.6.0",