|
|
|
@ -0,0 +1,9 @@ |
|
|
|
<!DOCTYPE html><html></html><body><h1>DocAST Documentation</h1><h3>parseFile(filename, options)</h3><pre>Parse documentation information from the provided filename argument |
|
|
|
</pre><h5>Params</h5><ul><li>filename [String]<pre>filename of the script you wish to parse</pre></li><li>options [Object]<pre>Available options: |
|
|
|
- tolerant: try to keep parsing the file even if errors are encountered [default: true] |
|
|
|
</pre></li></ul><h5>Returns</h5><ul><li>[Array]<pre>a list of doc comments parsed from the source filename</pre></li></ul><h3>parseContents(contents, options)</h3><pre>Parse documentation information from the provided string content |
|
|
|
|
|
|
|
This function is also available under `docast.parse(contents, options)` |
|
|
|
</pre><h5>Params</h5><ul><li>contents [String]<pre>string content to parse docs from</pre></li><li>options [Object]<pre>Available options: |
|
|
|
- tolerant: try to keep parsing the file even if errors are encountered [default: true] |
|
|
|
</pre></li></ul><h5>Returns</h5><ul><li>[Array]<pre>a list of doc comments parsed from the source string contents</pre></li></ul></body> |
