Add command to generate docs from ts code
This commit is contained in:
parent
2a3b084e8c
commit
65ab6dcac0
3
.gitignore
vendored
3
.gitignore
vendored
@ -63,3 +63,6 @@ lib
|
|||||||
lib-esm
|
lib-esm
|
||||||
# UMD bundles that export the global variable
|
# UMD bundles that export the global variable
|
||||||
_bundles
|
_bundles
|
||||||
|
|
||||||
|
# generated documentation
|
||||||
|
docs
|
@ -4,4 +4,4 @@ tslint.json
|
|||||||
webpack.config.js
|
webpack.config.js
|
||||||
yarn.lock
|
yarn.lock
|
||||||
src
|
src
|
||||||
|
docs
|
||||||
|
@ -17,7 +17,9 @@
|
|||||||
"build": "npm run clean && run-p build:*",
|
"build": "npm run clean && run-p build:*",
|
||||||
"lint": "tslint src/ts/**/*",
|
"lint": "tslint src/ts/**/*",
|
||||||
"test": "run-s clean build:commonjs && mocha lib/test/**/*.js",
|
"test": "run-s clean build:commonjs && mocha lib/test/**/*.js",
|
||||||
"test:coverage": "nyc npm run test --all"
|
"test:coverage": "nyc npm run test --all",
|
||||||
|
"docs:generate": "typedoc --out docs .",
|
||||||
|
"docs:open": "opn docs/index.html"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -35,10 +37,12 @@
|
|||||||
"mocha": "^3.4.1",
|
"mocha": "^3.4.1",
|
||||||
"npm-run-all": "^4.0.2",
|
"npm-run-all": "^4.0.2",
|
||||||
"nyc": "^10.3.2",
|
"nyc": "^10.3.2",
|
||||||
|
"opn-cli": "^3.1.0",
|
||||||
"shx": "^0.2.2",
|
"shx": "^0.2.2",
|
||||||
"source-map-support": "^0.4.15",
|
"source-map-support": "^0.4.15",
|
||||||
"tslint": "^5.3.2",
|
"tslint": "^5.3.2",
|
||||||
"tslint-config-0xproject": "^0.0.2",
|
"tslint-config-0xproject": "^0.0.2",
|
||||||
|
"typedoc": "^0.7.1",
|
||||||
"typescript": "^2.3.3",
|
"typescript": "^2.3.3",
|
||||||
"webpack": "^2.6.0"
|
"webpack": "^2.6.0"
|
||||||
}
|
}
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
export class ZeroEx {
|
export class ZeroEx {
|
||||||
|
/** Verifies the signature */
|
||||||
public verifySignature() {
|
public verifySignature() {
|
||||||
// TODO
|
// TODO
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user