From 12cfa02ee386177cba1729c869d14a15ee691114 Mon Sep 17 00:00:00 2001 From: Christian Fritz Date: Tue, 30 Jan 2024 10:38:19 -0800 Subject: [PATCH] Update NODE_API.md (#1616) - fix order -> sortOrder - added example --- docs/NODE_API.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/NODE_API.md b/docs/NODE_API.md index c5716e70b..f0f9d3dcc 100644 --- a/docs/NODE_API.md +++ b/docs/NODE_API.md @@ -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 `[]`) @@ -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