Skip to content
This repository has been archived by the owner on Aug 20, 2020. It is now read-only.

Added ESDoc support #45

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .esdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"source": "./lib",
"destination": "./docs",
"plugins": [
{
"name": "esdoc-coverage-plugin",
"option": {
"enable": true,
"kind": ["class", "method", "member", "get", "set", "constructor", "function", "variable"]
}
}
]
}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ lib-cov
# Coverage directory used by tools like istanbul
coverage

# Documentation directory generated by ESDoc
docs/

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ Generally, we follow the style guidelines as suggested by the official language.
Please run your code through:

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

<a name="creating-a-pull-request"></a>
## Creating a Pull Request
Expand Down
12 changes: 12 additions & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,15 @@ To run the example:
```bash
node examples/example
```

# Documentation

If you would like to auto-generate documentation of the packages, you can do so locally by running:
```
./node_modules/.bin/esdoc
```
Using the .esdoc.json file, esdoc will create documentation in the docs directory.

## Checking docs coverage

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.
Loading