Skip to content

Commit

Permalink
Implemented configured Jsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
MitchPierias committed Apr 19, 2019
1 parent 4422d7b commit 412911a
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,7 @@ typings/
lib/

# JSDoc ouput
out/
docs/

# Apple files
.DS_Store
26 changes: 26 additions & 0 deletions conf.json
Original file line number Diff line number Diff line change
@@ -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/"
}
}
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 412911a

Please sign in to comment.