commit 78a616c7cf0726383fe424b1c099b09a777e5e09 Author: brettlangdon Date: Sun Jan 25 21:48:05 2015 -0500 initial commit diff --git a/index.html b/index.html new file mode 100644 index 0000000..6e45934 --- /dev/null +++ b/index.html @@ -0,0 +1,9 @@ +

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