DocAST Documentation

parseFile(filename, options)

Parse documentation information from the provided filename argument

Params

• filename [String]

  filename of the script you wish to parse

• options [Object]

  Available options:
  - tolerant: try to keep parsing the file even if errors are encountered [default: true]
  

Returns

• [Array]

  a list of doc comments parsed from the source filename

parseContents(contents, options)

Parse documentation information from the provided string content

This function is also available under `docast.parse(contents, options)`

Params

• contents [String]

  string content to parse docs from

• options [Object]

  Available options:
  - tolerant: try to keep parsing the file even if errors are encountered [default: true]
  

Returns

• [Array]

  a list of doc comments parsed from the source string contents