Generate API docs with JSDoc

Add npm docs script to generate api docs with JSDoc.
This commit is contained in:
Hornwitser committed 2020-04-03 20:51:28 +02:00
1 parent 5c16809b5b
commit 17973e767e
3 files changed
+28

No files matched your search

+3
View File
@@ -25,6 +25,9 @@ coverage
build/Release
dist/
# Autogenerated docs output
/docs/api
node_modules/*
Factorio*
+23
View File
@@ -0,0 +1,23 @@
{
"plugins": [
"plugins/markdown"
],
"tags": {
"allowUnknownTags": false
},
"opts": {
"destination": "docs/api",
"recurse": true
},
"source": {
"include": [
"master.js",
"slave.js",
"clusterctl.js",
"lib/",
"plugins/",
"routes/",
"routes.js"
]
}
}
+2
View File
@@ -10,6 +10,7 @@
"cover": "nyc npm test",
"fast-cover": "FAST_TEST=y nyc npm test",
"ci-cover": "nyc --reporter=lcovonly npm run-script test",
"docs": "jsdoc --configure docs/jsdoc.json",
"install": "node lib/npmPostinstall",
"bundle-dependencies": "bundle-dependencies"
},
@@ -67,6 +68,7 @@
},
"devDependencies": {
"html5-validator": "^1.2.1",
"jsdoc": "^3.6.3",
"klaw": "^3.0.0",
"mocha": "^6.2.0",
"mocha-sinon": "^2.1.0",