Skip to content

Commit 7b9cfa6

Browse files
committed
updated documentation
1 parent bcfb384 commit 7b9cfa6

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,18 @@ Type: `String`
6161

6262
Custom filename for md or json output.
6363

64+
#### options.access
65+
Type: `Array`
66+
Default value: `['protected', 'public', 'undefined']`
67+
68+
Include only comments with a given access level, out of `private`, `protected`, `public` and `undefined`. By default, `public`, `protected` and `undefined` access levels are included.
69+
70+
#### options.order
71+
Type: `Array`
72+
Default value: `[]`
73+
74+
An array defining explicit sort order.
75+
6476
## Contributing
6577
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint your code using [Grunt](http://gruntjs.com/).
6678

0 commit comments

Comments
 (0)