pon-doc

3.0.1 • Public • Published

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

Param type Description
filename string Filename to read

License

This software is released under the Apache-2.0 License.

Links

Readme

Keywords

Package Sidebar

Install

npm i pon-doc

Weekly Downloads

3

Version

3.0.1

License

Apache-2.0

Unpacked Size

29 kB

Total Files

28

Last publish

Collaborators

  • okunishinishi
  • realglobe