File tree Expand file tree Collapse file tree 1 file changed +3
-2
lines changed Expand file tree Collapse file tree 1 file changed +3
-2
lines changed Original file line number Diff line number Diff line change @@ -72,7 +72,7 @@ comments, given a root file as a path.
7272 generated documentation.
7373 * ` args.shallow ` ** [ boolean] [ 20 ] ** whether to avoid dependency parsing
7474 even in JavaScript code. (optional, default ` false ` )
75- * ` args.order ` ** [ Array] [ 17 ] <([ string] [ 18 ] | [ Object] [ 19 ] )>** optional array that
75+ * ` args.sortOrder ` ** [ Array] [ 17 ] <([ string] [ 18 ] | [ Object] [ 19 ] )>** optional array that
7676 defines sorting order of documentation (optional, default ` [] ` )
7777 * ` args.access ` ** [ Array] [ 17 ] <[ string] [ 18 ] >** an array of access levels
7878 to output in documentation (optional, default ` [] ` )
@@ -94,7 +94,8 @@ var documentation = require('documentation');
9494
9595documentation .build ([' index.js' ], {
9696 // only output comments with an explicit @public tag
97- access: [' public' ]
97+ access: [' public' ],
98+ sortOrder: [' kind' , ' alpha' ]
9899}).then (res => {
99100 // res is an array of parsed comments with inferred properties
100101 // and more: everything you need to build documentation or
You can’t perform that action at this time.
0 commit comments