Document parser for pon
npm install pon-docpon-doc
==========
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]
[bd_repo_url]: https://github.com/realglobe-Inc/pon-doc
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/pon-doc
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/pon-doc.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/pon-doc
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/pon-doc.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/pon-doc/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/pon-doc
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/pon-doc.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/pon-doc.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/pon-doc
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/pon-doc.svg
[bd_npm_url]: http://www.npmjs.org/package/pon-doc
[bd_npm_shield_url]: http://img.shields.io/npm/v/pon-doc.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
Document parser for pon
Installation
-----
``bash`
$ npm install pon-doc --save
Usage
---------
`javascript
'use strict'
const {functionComments} = require('pon-doc')
{
const comments = functionComments('lib/my-file.js')
console.log(comments) // -> Parsed function jsdoc comments
}
``
Signatures
---------
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
------
+ [Pon][pon_url]
+ [Realglobe, Inc.][realglobe,_inc__url]
[pon_url]: https://github.com/realglobe-Inc/pon
[realglobe,_inc__url]: http://realglobe.jp