JSPM

  • Created
  • Published
  • Downloads 271150
  • Score
    100M100P100Q167076F
  • License MIT

A programmatic interface for jsdoc

Package Exports

  • jsdoc-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdoc-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

view on npm npm module downloads per month Build Status Dependency Status js-standard-style Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

jsdoc-api

Example

const jsdoc = require('jsdoc-api')

jsdoc-api.explain(source) ⇒ object

Kind: static method of jsdoc-api
Returns: object - - json

Param Type Description
source string source code

jsdoc-api.render(source, [options])

Kind: static method of jsdoc-api

Param Type Description
source string the source code
[options] object options
[options.destination] destination path

© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.