diff options
| author | Fabio Berger <me@fabioberger.com> | 2017-05-24 23:03:51 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-24 23:03:51 +0800 |
| commit | b5bd772b240e656ed95150e0d1b6bd77f754aa5c (patch) | |
| tree | b9c7f336c785bef0812dd830b91e67565d4e92ab | |
| parent | 2a3b084e8c298f947fe905e6505c2ac95c2b5b0b (diff) | |
| parent | 01b65a171e8c05b4059ca2f5b7b2aa4601b7c14b (diff) | |
| download | dexon-0x-contracts-b5bd772b240e656ed95150e0d1b6bd77f754aa5c.tar.gz dexon-0x-contracts-b5bd772b240e656ed95150e0d1b6bd77f754aa5c.tar.zst dexon-0x-contracts-b5bd772b240e656ed95150e0d1b6bd77f754aa5c.zip | |
Merge pull request #7 from 0xProject/docs
Add command to generate docs from ts code
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | .npmignore | 2 | ||||
| -rw-r--r-- | package.json | 7 | ||||
| -rw-r--r-- | src/ts/0x.js.ts | 1 |
4 files changed, 11 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore index ed650c3f6..3c6a1ab6f 100644 --- a/.gitignore +++ b/.gitignore @@ -63,3 +63,6 @@ lib lib-esm # UMD bundles that export the global variable _bundles + +# generated documentation +docs
\ No newline at end of file diff --git a/.npmignore b/.npmignore index db6c83e43..55e749592 100644 --- a/.npmignore +++ b/.npmignore @@ -4,4 +4,4 @@ tslint.json webpack.config.js yarn.lock src - +docs diff --git a/package.json b/package.json index d67890d84..340e042ce 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,10 @@ "build": "npm run clean && run-p build:*", "lint": "tslint src/ts/**/*", "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:json": "typedoc --json docs/index.json .", + "docs:generate": "typedoc --out docs .", + "docs:open": "opn docs/index.html" }, "repository": { "type": "git", @@ -35,10 +38,12 @@ "mocha": "^3.4.1", "npm-run-all": "^4.0.2", "nyc": "^10.3.2", + "opn-cli": "^3.1.0", "shx": "^0.2.2", "source-map-support": "^0.4.15", "tslint": "^5.3.2", "tslint-config-0xproject": "^0.0.2", + "typedoc": "^0.7.1", "typescript": "^2.3.3", "webpack": "^2.6.0" } diff --git a/src/ts/0x.js.ts b/src/ts/0x.js.ts index ac9e3376d..95446ad74 100644 --- a/src/ts/0x.js.ts +++ b/src/ts/0x.js.ts @@ -1,4 +1,5 @@ export class ZeroEx { + /** Verifies the signature */ public verifySignature() { // TODO } |