3.0.1 • Published 5 years ago

pon-doc v3.0.1

Weekly downloads
4
License
Apache-2.0
Repository
github
Last release
5 years ago

pon-doc

Build Status npm Version JS Standard

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

ParamtypeDescription
filenamestringFilename to read

License

This software is released under the Apache-2.0 License.

Links

3.0.1

5 years ago

2.0.1

7 years ago