Skip to content

Commit

Permalink
Update NODE_API.md (#1616)
Browse files Browse the repository at this point in the history
- fix order -> sortOrder
- added example
  • Loading branch information
chfritz authored Jan 30, 2024
1 parent de30e89 commit 12cfa02
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/NODE_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ comments, given a root file as a path.
generated documentation.
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
even in JavaScript code. (optional, default `false`)
* `args.order` **[Array][17]<([string][18] | [Object][19])>** optional array that
* `args.sortOrder` **[Array][17]<([string][18] | [Object][19])>** optional array that
defines sorting order of documentation (optional, default `[]`)
* `args.access` **[Array][17]<[string][18]>** an array of access levels
to output in documentation (optional, default `[]`)
Expand All @@ -94,7 +94,8 @@ var documentation = require('documentation');

documentation.build(['index.js'], {
// only output comments with an explicit @public tag
access: ['public']
access: ['public'],
sortOrder: ['kind', 'alpha']
}).then(res => {
// res is an array of parsed comments with inferred properties
// and more: everything you need to build documentation or
Expand Down

0 comments on commit 12cfa02

Please sign in to comment.