Skip to content

Commit 1b3e724

Browse files
author
Matt Bernier
authored
Merge pull request #53 from mptap/add-esdoc-support
Added esdoc support
2 parents caf8eaf + 5ee30aa commit 1b3e724

File tree

6 files changed

+30
-2
lines changed

6 files changed

+30
-2
lines changed

.esdoc.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"source": "./lib",
3+
"destination": "./docs",
4+
"plugins": [
5+
{
6+
"name": "esdoc-coverage-plugin",
7+
"option": {
8+
"enable": true,
9+
"kind": ["class", "method", "member", "get", "set", "constructor", "function", "variable"]
10+
}
11+
}
12+
]
13+
}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
node_modules/
22
.DS_Store
33
npm-debug.log
4+
docs
45
.env

.travis.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ node_js:
55
- "6"
66
- "7"
77
- "8"
8-
- "node"
9-
- "lts/*"
108
notifications:
119
hipchat:
1210
rooms:

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ Generally, we follow the style guidelines as suggested by the official language.
137137
Please run your code through:
138138

139139
- [ESLint](http://eslint.org/) with the standard style guide.
140+
- [esdoc](https://github.com/sendgrid/smtpapi-nodejs/blob/master/.github/USAGE.md) to check the documentation coverage of your added code.
140141

141142
## Creating a Pull Request<a name="creating-a-pull-request"></a>
142143

USAGE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Documentation
2+
3+
If you would like to auto-generate documentation of the packages, you can do so locally by running:
4+
```
5+
./node_modules/.bin/esdoc
6+
```
7+
Using the .esdoc.json file, esdoc will create documentation in the docs directory.
8+
9+
## Checking docs coverage
10+
11+
You will find a coverage.json file in the docs directory. This will contain information about the documentation coverage for each of the different files in this repo.

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
"author": "scottmotte",
2626
"license": "BSD",
2727
"dependencies": {
28+
"chai": "^2.3.0",
29+
"esdoc": "^1.0.3",
30+
"esdoc-coverage-plugin": "^1.1.0",
31+
"esdoc-type-inference-plugin": "^1.0.1"
2832
},
2933
"devDependencies": {
3034
"mocha": "3.5.3",

0 commit comments

Comments
 (0)