docs: 优化一些文档

novlan1 · Oct 9, 2022 · f66709f · f66709f
1 parent 1666a1c
commit f66709f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/script/docs/jsdoc-local.js b/script/docs/jsdoc-local.js
@@ -2,4 +2,5 @@ const { JsDocHandler } = require('../../lib/index');
 
 JsDocHandler.init({
   author: 'novlan1',
+  isHandleNav: true,
 });
diff --git a/src/jsdoc/jsdoc.ts b/src/jsdoc/jsdoc.ts
@@ -45,6 +45,7 @@ class JsDocHandler {
    * @param {string} [options.author] 作者，默认为空
    * @param {string} [options.extraCss] 额外插入的css，默认为`.nav-separator`的一些样式
    * @param {string} [options.navHandler] 处理API所在文件的方法
+   * @param {boolean} [options.isHandleNav] 是否处理导航栏，即插入文件名进行分隔，默认为false
    * @returns {object} JsDocHandler实例
    * @example
    *