pon-doc
v3.0.1
Published
Document parser for pon
Downloads
11
Readme
pon-doc
Document parser for pon
Installation
$ npm install pon-doc --save
Usage
'use strict'
const {functionComments} = require('pon-doc')
{
const comments = functionComments('lib/my-file.js')
console.log(comments) // -> Parsed function jsdoc comments
}
Signatures
functionComments(filename) -> Object[]
Parse function comments in file
| Param | type | Description | | ---- | --- | ----------- | | filename | string | Filename to read |
License
This software is released under the Apache-2.0 License.