From 412911af892c313884554b61b3570a216169ecde Mon Sep 17 00:00:00 2001 From: Mitch Pierias Date: Fri, 19 Apr 2019 22:49:22 +1000 Subject: [PATCH] Implemented configured Jsdocs --- .gitignore | 5 ++++- conf.json | 26 ++++++++++++++++++++++++++ package.json | 3 ++- 3 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 conf.json diff --git a/.gitignore b/.gitignore index 77d5205..a2f03f3 100644 --- a/.gitignore +++ b/.gitignore @@ -64,4 +64,7 @@ typings/ lib/ # JSDoc ouput -out/ \ No newline at end of file +docs/ + +# Apple files +.DS_Store \ No newline at end of file diff --git a/conf.json b/conf.json new file mode 100644 index 0000000..f54d8f7 --- /dev/null +++ b/conf.json @@ -0,0 +1,26 @@ +{ + "plugins": [], + "recurseDepth": 10, + "source": { + "include": [ + "./lib" + ], + "exclude": [ + "./src" + ], + "includePattern": ".+\\.(js)x?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "sourceType": "module", + "tags": { + "allowUnknownTags": true, + "dictionaries": ["jsdoc","closure"] + }, + "templates": { + "cleverLinks": false, + "monospaceLinks": false + }, + "opts": { + "destination": "./docs/" + } +} \ No newline at end of file diff --git a/package.json b/package.json index 3d2c9b6..3bab155 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,8 @@ "prepublishOnly": "npm test", "prepare": "npm run build", "test": "jest --config jestconfig.json", - "test:mocha": "mocha --require ts-node/register src/**/*.test.ts" + "test:mocha": "mocha --require ts-node/register src/**/*.test.ts", + "doc":"jsdoc -c ./conf.json" }, "repository": { "type": "git",