Skip to content

A simple jsdoc plugin that very generically strips async and await keywords from the source file before jsdoc processes it.

License

Notifications You must be signed in to change notification settings

jcowgar/jsdoc-strip-async-await

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jsdoc-strip-async-await

A simple jsdoc plugin that very generically strips async and await keywords from the source file before jsdoc processes it. This allows one to generate documentation for source files that contain async or await.

Installation

$ npm install --save-dev jsdoc-strip-async-await

Usage

Add jsdoc-strip-async-await to your jsdoc config file.

Configuring JSDoc with conf.json

{
  "plugins": ["node_modules/jsdoc-strip-async-await"]
}

Notes

As soon as jsdoc supports async and await natively, this plugin should be removed from your documentation process.

About

A simple jsdoc plugin that very generically strips async and await keywords from the source file before jsdoc processes it.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published