Skip to content

Commit

Permalink
Switch from jsdoc to typedoc
Browse files Browse the repository at this point in the history
Typedoc is jsdoc for typescript. Unfortunately, it doesn't yet
to anything very useful because we need library mode, which
is currently in development (TypeStrong/typedoc#1364).
But jsdoc doesn't do anything at all so this is better.
  • Loading branch information
gcampax committed Sep 22, 2020
1 parent d32290e commit 010df5d
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 127 deletions.
4 changes: 2 additions & 2 deletions package.json
Expand Up @@ -34,13 +34,13 @@
"coveralls": "^3.0.0",
"deep-equal": "^2.0.1",
"eslint": "^7.1.0",
"jsdoc": "^3.6.3",
"nyc": "^15.0.0",
"pegjs": "~0.10.0",
"q": "^1.5.1",
"seedrandom": "^3.0.0",
"source-map-support": "^0.5.19",
"ts-node": "^9.0.0",
"typedoc": "^0.19.2",
"typescript": "^4.0.3"
},
"scripts": {
Expand All @@ -50,7 +50,7 @@
"test": "nyc ts-node ./test/test_all",
"coverage": "nyc report --reporter=text-lcov | coveralls",
"prepare": "make",
"doc": "jsdoc -c jsdoc.json --readme README.md --package package.json --verbose -r index.js lib/"
"doc": "typedoc lib/index.ts"
},
"nyc": {
"extends": "@istanbuljs/nyc-config-typescript",
Expand Down
6 changes: 6 additions & 0 deletions tsconfig.json
Expand Up @@ -14,5 +14,11 @@
"sourceMap": true,
"incremental": true,
"declaration": true
},
"typedocOptions": {
"mode": "library",
"out": "doc",
"name": "ThingTalk",
"readme": "README.md"
}
}

0 comments on commit 010df5d

Please sign in to comment.