1.0.0-dev • Published 6 years ago
docblock-reader v1.0.0-dev
docblock-reader
A docblock parser. Currently in development, starting with support for docblocks formatted based on JSDoc and WordPress standards.
Install
npm install docblock-readerOR
yarn add docblock-readerUsage example
import getDocblocks from 'docblock-reader';
getDocblocks({
files:['./src/index.js', './src/someOtherFile.js'],
context: 'javascript',
callback: console.log
});Parameters
| Name | Type | Description | Required/Default |
|---|---|---|---|
| files | array/string | An array of files or a glob (e.g. ./src/**/*.js) | required |
| context | string | The language context for which the docblocks should be parsed. Supports 'wordpress' and 'javascript'. | default 'javascript' |
| callback | function | A callback for handling the parsed docblocks. | required |
1.0.0-dev
6 years ago