api.md

parser

This is a parser!

• setParser

  Create a new parser or override an old ones

  • param: name { string }

    parser's name

  • param: parser { Object }

    parser object

• parse

  Parse source code directly.

  • param: source { string }

    source code

  • param: language { string }

    specify source language

  • param: opts { Object= }

    option

  • return: { Array }

    parsed comments object array

• parseFile

  Parse source code from file. Use Promise instead of callback

  • param: filePath { string }

    souce file path

  • param: opts { Object= }

    option

  • return: { Promise }

    resolve parsed comment object

• parseFileSync

  Synchronous version of parseFile

  • return: { Object }

    parsed comment object array

• setRule

  Set parser's rule

  • param: language { String }

    parser name

  • param: rule { Object }

    parser's rule