From 99fe1570862d0740af1b8dd88960e978a122ce7c Mon Sep 17 00:00:00 2001 From: AZMCode Date: Sun, 9 Aug 2020 16:46:08 -0400 Subject: [PATCH] Added typedoc. Runnable with yarn build:docs Signed-off-by: AZMCode --- .gitignore | 1 + package.json | 2 ++ typedoc.json | 5 +++++ 3 files changed, 8 insertions(+) create mode 100644 typedoc.json diff --git a/.gitignore b/.gitignore index e62745a..d609a01 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ package-lock.json decoded-ws.json auth_info2.json lib +doc diff --git a/package.json b/package.json index 3f3bcb0..2b5552d 100644 --- a/package.json +++ b/package.json @@ -21,6 +21,7 @@ "test": "mocha --timeout 60000 -r ts-node/register src/*/Tests.ts", "lint": "eslint '*/*.ts' --quiet --fix", "build": "tsc", + "build:docs":"typedoc", "example": "npx ts-node Example/example.ts", "browser-decode": "npx ts-node src/WAConnection/BrowserMessageDecoding.ts" }, @@ -54,6 +55,7 @@ "mocha": "^8.0.1", "prettier": "^2.0.5", "ts-node-dev": "^1.0.0-pre.49", + "typedoc": "^0.18.0", "typescript": "^3.9.5" } } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..4283d12 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,5 @@ +{ + "inputFiles": ["./src"], + "mode": "modules", + "out": "doc" +}