• 引入
• JsDocHandler
  • new JsDocHandler(options)
  • JsDocHandler.init(options) ⇒ object

引入

import { JsDocHandler  } from 't-comm';

// or

import { JsDocHandler } from 't-comm/lib/jsdoc/index';

JsDocHandler

参数：

• JsDocHandler
  • new JsDocHandler(options)
  • .init(options) ⇒ object

new JsDocHandler(options)

处理jsdoc的脚本

1. 增加导航栏的分隔符
2. 增加css
3. 处理footer

Param	Type	Description
options	object	配置
[options.docsPath]	string	文档所在目录位置，默认为./docs
[options.author]	string	作者，默认为空
[options.extraCss]	string	额外插入的css，默认为.nav-separator的一些样式
[options.extraScript]	string	额外插入的script
[options.navHandler]	function	处理API所在文件的方法
[options.isHandleNav]	boolean	是否处理导航栏，即插入文件名进行分隔，默认为false

JsDocHandler.init(options) ⇒ object

初始化并运行

Kind: static method of JsDocHandler
Returns: object -

JsDocHandler实例

Param	Type	Description
options	object	配置
[options.docsPath]	string	文档所在目录位置，默认为./docs
[options.author]	string	作者，默认为空
[options.extraCss]	string	额外插入的css，默认为.nav-separator的一些样式
[options.navHandler]	string	处理API所在文件的方法
[options.isHandleNav]	boolean	是否处理导航栏，即插入文件名进行分隔，默认为false

Example

JsDocHandler.init({
  author: 'novlan1',
  docsPath: './docs',
  extraCss: '.some-class{}',
  navHandler(nav) {

  }
})