0.0.1-alpha.2
  • 编辑此页(E)
  • 报告 BUG(B)
  • 查看源码(V)
  • 单元测试(U)

    • DocCompiler

    xuld
    2020/11/9(#1, xuld)

    API

    查看源码
    (共 2678 行)    DocCompiler 类

    表示一个文档编译器

    构造函数

    DocCompiler查看源码
    (共 219 行)    new DocCompiler

    初始化新的编译器

    参数
    参数名说明类型
    builder

    所属的构建器

    		Builder

    属性

    属性名说明类型
    options只读

    获取编译器的选项

    展开子属性
    • baseURL: string — 生成的页面中引用资源的根地址
    • logo: string — 项目 LOGO，可以是一段 <svg> 或 <img> 源码
    • displayName: string — 项目展示名，用于网站标题栏及左上角 LOGO 文案
    • version: string — 项目版本
    • versions: array — 其它版本链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • navbar: array — 顶部导航条链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • children: array — 子菜单
        • label: string — 链接文案
        • href: string — 链接地址
        • title: string — 鼠标悬停时的工具提示
    • footer: array — 底部链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • copyright: string — 底部版权声明
    • injectHead: string — 生成的文档头部插入的 HTML 代码，比如 SEO 标记
    • injectFoot: string — 生成的文档末尾插入的 HTML 代码，比如放入一些统计代码
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 定制为每个标题生成序号
    • backToTop: boolean — 是否插入返回顶部链接
    • introDescription: string — 项目描述
    • introButtons: array — 项目描述后的按钮
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • features: array — 项目优势说明链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • icon: string — 图标
      • description: string — 描述文案
    • links: array — 友情链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
      • icon: string — 图标
    • support — 支持/赞助链接
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • packageName: string — 发布的包名
    • repository: string — 项目仓库地址(HTTPS 协议)
    • repositoryPath: string — 项目根目录在仓库中的路径
    • branch: string — 项目仓库分支
    • readCommits: (files: string[]) => CommitInfo[] | Promise<CommitInfo[]> — 读取指定文件的修改记录
    		DocCompilerOptions
    builder只读

    所属的构建器

    		Builder
    markdownCompiler只读

    获取使用的 Markdown 编译器

    		MarkdownCompiler
    icons只读

    所有可用图标

    		{[name: string]: string}
    searchKeywords只读

    每个页面对应的搜索关键字

    		{[url: string]: string[]}

    方法

    DocCompiler查看源码
    (共 171 行)    buildDocPage异步

    构建指定的文档页

    参数
    参数名说明类型
    content

    要编译的 Markdown 源码

    		string
    path

    模块的原始绝对路径

    		string
    outPath

    模块的输出绝对路径

    		string
    (可选)options

    附加选项

    		Partial<DocPageMeta>
    返回值
    类型：Promise<{content: stringerrors: LogEntry[]dependencies: (string | DependencyCallback)[]}>

    DocCompiler查看源码
    (共 22 行)    buildIndexPage异步

    生成一个列表页

    参数
    参数名说明类型
    pathstring
    返回值
    类型：Promise<CompileResult>

    DocCompiler查看源码
    (共 9 行)    addSearchKeyword

    添加指定页面对应的搜索关键字

    参数
    参数名说明类型
    url

    页面地址

    		string
    keyword

    要添加的关键字

    		string
    返回值
    类型：void

    DocCompiler查看源码
    (共 73 行)    buildData异步

    生成前端页面需要的数据

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：Promise<CompileResult>

    DocCompiler查看源码
    (共 10 行)    getGeneratedDataURLs异步生成器

    获取动态生成的所有文件的地址

    返回值
    类型：AsyncGenerator<string, void, unknown>

    DocCompiler查看源码
    (共 33 行)    loadPageIndex异步

    获取指定文件夹的索引数据

    参数
    参数名说明类型
    dir

    要扫描的文件夹绝对路径

    		string
    返回值
    类型：Promise<{autoGenerated: booleanpath: stringdependencies: (string | DependencyCallback)[]header: stringtitle: stringbody: stringitems: MarkdownListItem[]}>

    DocCompiler查看源码
    (共 70 行)    generatePageIndex异步

    扫描并生成指定文件夹的页面列表

    参数
    参数名说明类型
    dir

    要扫描的文件夹

    		string
    (可选)root

    所属的根文件夹

    默认值：dir;

    		string
    (可选)extensions

    扫描的文件扩展名

    		string[]
    返回值
    类型：Promise<MarkdownListItem[]>

    DocCompiler查看源码
    (共 24 行)    loadPageIndexItem异步

    解析指定页面对应的列表项

    参数
    参数名说明类型
    path

    要查询的页面

    		string
    (可选)checkExists

    是否检查文件是否存在

    		boolean
    返回值
    类型：Promise<MarkdownListItem>

    DocCompiler查看源码
    (共 7 行)    getPageIndexURL

    获取指定地址对应的页面索引地址

    参数
    参数名说明类型
    url

    要处理的地址

    		string
    返回值
    类型：string

    DocCompiler查看源码
    (共 7 行)    getSearchIndexURL

    获取搜索索引地址

    参数
    参数名说明类型
    url

    要处理的地址

    		string
    返回值
    类型：string

    DocCompiler查看源码
    (共 9 行)    buildUnitTestPage

    构建一个单元测试页

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：CompileResult

    DocCompiler查看源码
    (共 9 行)    buildHomePage

    构建一个首页

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：CompileResult

    DocCompiler查看源码
    (共 66 行)    buildErrorPage

    构建一个错误页面

    参数
    参数名说明类型
    errors

    已解析的错误日志

    展开子属性
    • source: string — 日志的来源
    • message: string — 日志的信息
    • fileName: string — 日志相关的文件名
    • line: number — 日志相关的行号（从 0 开始）
    • column: number — 日志相关的列号（从 0 开始）
    • endLine: number — 日志相关的结束行号（从 0 开始）
    • endColumn: number — 日志相关的结束列号（从 0 开始）
    • detail: string — 日志的详情
    • codeFrame: string — 日志相关的源代码片段
    • stack: string — 错误堆栈信息
    		LogEntry[]
    ext

    文件扩展名

    		string
    content

    当前文件内容

    		string | Buffer
    返回值
    类型：string

    DocCompiler查看源码
    (共 26 行)    compileEmbedJS保护

    编译 Markdown 中内嵌的 JS 代码

    参数
    参数名说明类型
    content

    要编译的代码

    		string
    lang

    首选的语言

    		string
    context

    生成 Markdown 的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：string

    DocCompiler查看源码
    (共 12 行)    compileEmbedHTML保护

    编译 Markdown 中内嵌的 HTML 代码

    参数
    参数名说明类型
    content

    要编译的代码

    		string
    script

    首选的脚本语言

    		string
    style

    首选的样式语言

    		string
    context

    生成 Markdown 的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：string

    DocCompiler查看源码
    (共 28 行)    compileEmabedCode保护

    编译 Markdown 中内嵌的代码，如果不支持该语言则返回 undefined

    参数
    参数名说明类型
    content

    要编译的代码

    		string
    language

    语言

    		string
    context

    生成 Markdown 的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：{container: stringjs: stringhtml?: undefined} | {container: stringhtml: stringjs?: undefined}

    DocCompiler查看源码
    (共 16 行)    renderCodeToolBar保护

    渲染代码区块的工具条

    参数
    参数名说明类型
    content

    要编译的代码

    		string
    language

    语言

    		string
    info

    代码块的信息

    		string
    compiledCode

    已编译的代码

    展开子属性
    • html: string
    • js: string
    • container: string
    		{html?: stringjs?: stringcontainer?: string}
    context

    生成 Markdown 的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 14 行)    parseMarkdownMeta保护

    解析 Markdown 的元数据

    参数
    参数名说明类型
    content

    要解析的内容

    		string
    path

    文件的路径

    		string
    返回值
    类型：DocPageMeta

    DocCompiler查看源码
    (共 11 行)    renderTools保护

    渲染工具栏

    参数
    参数名说明类型
    context

    当前页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 43 行)    renderToolItems保护

    渲染工具栏项

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 19 行)    renderTitle保护

    渲染一个标题

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 23 行)    renderMetaInfo异步保护

    渲染页面头信息

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：Promise<?>

    DocCompiler查看源码
    (共 7 行)    getMetaInfo异步保护

    获取页面的元数据

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：Promise<[string, string, Link, Link[]][]>

    DocCompiler查看源码
    (共 35 行)    renderTOC保护

    渲染一个目录

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 20 行)    renderPageHead保护

    渲染页面顶部

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 16 行)    renderPageFoot保护

    渲染页面底部

    参数
    参数名说明类型
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 40 行)    renderDocPage保护

    渲染一个文档页

    参数
    参数名说明类型
    url

    文档的地址

    		string
    title

    文档的标题

    		string
    content

    文档正文

    		any
    返回值
    类型：string

    DocCompiler查看源码
    (共 18 行)    renderHead保护

    渲染顶部的 HTML

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    (可选)pageData

    页面的附加数据

    		any
    返回值
    类型：?

    DocCompiler查看源码
    (共 7 行)    renderFoot保护

    渲染底部的 HTML

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：HTML

    DocCompiler查看源码
    (共 48 行)    renderHeader保护

    渲染头部

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：?

    DocCompiler查看源码
    (共 15 行)    renderFooter保护

    渲染底部

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：?

    渲染一个链接

    参数
    参数名说明类型
    label

    链接的文案

    		any
    href

    链接的地址

    		string
    (可选)title

    鼠标悬停的工具提示

    		string
    (可选)className

    可选设置 CSS 类名

    		string
    返回值
    类型：?

    DocCompiler查看源码
    (共 12 行)    renderIcon保护

    渲染一个图标

    参数
    参数名说明类型
    name

    图标的名称

    		string
    (可选)className

    可选设置 CSS 类名

    		string
    返回值
    类型：HTML

    渲染本节链接

    参数
    参数名说明类型
    anchor

    当前链接的哈希值

    		string
    返回值
    类型：?

    DocCompiler查看源码
    (共 39 行)    renderAPIDoc保护

    渲染指定文件的 API 文档

    参数
    参数名说明类型
    sourcePath

    JS/TS 文件路径

    		string
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 14 行)    renderDocMembers保护

    渲染成员列表

    参数
    参数名说明类型
    members

    要渲染的成员

    		DocMember[]
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any[]

    DocCompiler查看源码
    (共 32 行)    renderDocMember保护

    渲染指定的成员

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 153 行)    renderDocClassOrInterface保护

    渲染一个类或接口

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • declaredType: Type — 声明的类型
    • typeParameters: array — 所有类型参数
      • raw: TypeParameter — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • constraintType: DocType — 约束类型
      • defaultType: DocType — 默认类型
    • extends: DocType[] — 继承类型
    • implements: DocType[] — 实现类型
    • members: DocMember[] — 所有成员（含继承的成员）
    • memberType: DocMemberType.class | DocMemberType.interface — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocClassOrInterface
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 12 行)    renderExtendingHierarchy保护

    渲染一个继承链

    参数
    参数名说明类型
    type

    基础类型

    		DocType
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 26 行)    renderDocConstructor保护

    渲染一个索引访问器

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • typeParameters: array — 所有类型参数
      • raw: TypeParameter — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • constraintType: DocType — 约束类型
      • defaultType: DocType — 默认类型
    • parameters: array — 所有参数
      • raw: Symbol — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • rest: boolean — 是否是展开参数
      • optional: boolean — 是否可选
      • type: DocType — 参数类型
      • defaultValue: Expression — 默认值
      • subParameters: array — 所有子参数
        • name: string — 参数名
        • summary: string — 概述
        • rest: boolean — 是否是展开参数
        • optional: boolean — 是否可选
        • type: DocType — 参数类型
        • defaultValue: Expression — 默认值
        • subParameters: (Circular)Pick<DocParameter, "name" | "summary" | "rest" | "optional" | "type" | "defaultValue" | "subParameters">[] — 所有子参数
    • returnType: DocType — 返回值类型
    • returnSummary: string — 返回值描述
    • overloads: array — 方法的多个重载
      • raw: ?
      • declaration: ?
      • name: ?
      • summary: ?
      • defaultValue: ?
      • typeParameters: ?
      • parameters: ?
      • returnType: ?
      • returnSummary: ?
      • memberType: ?
      • sourceLocation: ?
      • id: ?
      • modifiers: ?
      • parentMember: ?
      • baseMember: ?
      • overridingMember: ?
      • ignore: ?
      • deprecatedMessage: ?
      • description: ?
      • examples: ?
      • seeAlso: ?
      • since: ?
      • category: ?
      • unknownTags: ?
    • classOrInterface — 同名的类或接口
      • declaredType: Type — 声明的类型
      • typeParameters: array — 所有类型参数
        • raw: TypeParameter — 原始符号
        • name: string — 参数名
        • summary: string — 概述
        • constraintType: DocType — 约束类型
        • defaultType: DocType — 默认类型
      • extends: DocType[] — 继承类型
      • implements: DocType[] — 实现类型
      • members: DocMember[] — 所有成员（含继承的成员）
      • memberType: DocMemberType.class | DocMemberType.interface — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • namespace — 同名的命名空间
      • members: DocMember[] — 所有导出的成员
      • memberType: DocMemberType.namespace | DocMemberType.module — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • memberType: DocMemberType.function | DocMemberType.constructor | DocMemberType.method | DocMemberType.index | DocMemberType.call — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocFunction
    parentMember

    所属的类

    		DocMember
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 25 行)    renderDocProperty保护

    渲染一个属性

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • type: DocType — 值的类型
    • memberType: DocMemberType.var | DocMemberType.let | DocMemberType.const | DocMemberType.field | DocMemberType.accessor | DocMemberType.event — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocVariable
    preferRequested

    是否标记必填项而非可选项

    		boolean
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 15 行)    renderDocTypeDetail保护

    渲染类型的子属性

    参数
    参数名说明类型
    type

    要渲染的类型

    		DocType
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 20 行)    renderDocIndex保护

    渲染一个索引访问器

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • typeParameters: array — 所有类型参数
      • raw: TypeParameter — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • constraintType: DocType — 约束类型
      • defaultType: DocType — 默认类型
    • parameters: array — 所有参数
      • raw: Symbol — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • rest: boolean — 是否是展开参数
      • optional: boolean — 是否可选
      • type: DocType — 参数类型
      • defaultValue: Expression — 默认值
      • subParameters: array — 所有子参数
        • name: string — 参数名
        • summary: string — 概述
        • rest: boolean — 是否是展开参数
        • optional: boolean — 是否可选
        • type: DocType — 参数类型
        • defaultValue: Expression — 默认值
        • subParameters: (Circular)Pick<DocParameter, "name" | "summary" | "rest" | "optional" | "type" | "defaultValue" | "subParameters">[] — 所有子参数
    • returnType: DocType — 返回值类型
    • returnSummary: string — 返回值描述
    • overloads: array — 方法的多个重载
      • raw: ?
      • declaration: ?
      • name: ?
      • summary: ?
      • defaultValue: ?
      • typeParameters: ?
      • parameters: ?
      • returnType: ?
      • returnSummary: ?
      • memberType: ?
      • sourceLocation: ?
      • id: ?
      • modifiers: ?
      • parentMember: ?
      • baseMember: ?
      • overridingMember: ?
      • ignore: ?
      • deprecatedMessage: ?
      • description: ?
      • examples: ?
      • seeAlso: ?
      • since: ?
      • category: ?
      • unknownTags: ?
    • classOrInterface — 同名的类或接口
      • declaredType: Type — 声明的类型
      • typeParameters: array — 所有类型参数
        • raw: TypeParameter — 原始符号
        • name: string — 参数名
        • summary: string — 概述
        • constraintType: DocType — 约束类型
        • defaultType: DocType — 默认类型
      • extends: DocType[] — 继承类型
      • implements: DocType[] — 实现类型
      • members: DocMember[] — 所有成员（含继承的成员）
      • memberType: DocMemberType.class | DocMemberType.interface — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • namespace — 同名的命名空间
      • members: DocMember[] — 所有导出的成员
      • memberType: DocMemberType.namespace | DocMemberType.module — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • memberType: DocMemberType.function | DocMemberType.constructor | DocMemberType.method | DocMemberType.index | DocMemberType.call — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocFunction
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 36 行)    renderDocEnum保护

    渲染一个枚举类型

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • declaredType: Type — 声明的类型
    • members: DocMember[] — 所有枚举成员
    • memberType: DocMemberType.enum — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocEnum
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 15 行)    renderDocNamespace保护

    渲染一个命名空间

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • members: DocMember[] — 所有导出的成员
    • memberType: DocMemberType.namespace | DocMemberType.module — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocNamespace
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 15 行)    renderDocModule保护

    渲染一个包

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • members: DocMember[] — 所有导出的成员
    • memberType: DocMemberType.namespace | DocMemberType.module — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocNamespace
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 15 行)    renderDocTypeAlias保护

    渲染一个类型别名

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • declaredType: Type — 声明的类型
    • aliasedType: DocType — 等价的类型
    • memberType: DocMemberType.typeAlias — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocTypeAlias
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 15 行)    renderDocVariable保护

    渲染一个变量

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • type: DocType — 值的类型
    • memberType: DocMemberType.var | DocMemberType.let | DocMemberType.const | DocMemberType.field | DocMemberType.accessor | DocMemberType.event — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocVariable
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 21 行)    renderDocFunction保护

    渲染一个函数或方法

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • typeParameters: array — 所有类型参数
      • raw: TypeParameter — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • constraintType: DocType — 约束类型
      • defaultType: DocType — 默认类型
    • parameters: array — 所有参数
      • raw: Symbol — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • rest: boolean — 是否是展开参数
      • optional: boolean — 是否可选
      • type: DocType — 参数类型
      • defaultValue: Expression — 默认值
      • subParameters: array — 所有子参数
        • name: string — 参数名
        • summary: string — 概述
        • rest: boolean — 是否是展开参数
        • optional: boolean — 是否可选
        • type: DocType — 参数类型
        • defaultValue: Expression — 默认值
        • subParameters: (Circular)Pick<DocParameter, "name" | "summary" | "rest" | "optional" | "type" | "defaultValue" | "subParameters">[] — 所有子参数
    • returnType: DocType — 返回值类型
    • returnSummary: string — 返回值描述
    • overloads: array — 方法的多个重载
      • raw: ?
      • declaration: ?
      • name: ?
      • summary: ?
      • defaultValue: ?
      • typeParameters: ?
      • parameters: ?
      • returnType: ?
      • returnSummary: ?
      • memberType: ?
      • sourceLocation: ?
      • id: ?
      • modifiers: ?
      • parentMember: ?
      • baseMember: ?
      • overridingMember: ?
      • ignore: ?
      • deprecatedMessage: ?
      • description: ?
      • examples: ?
      • seeAlso: ?
      • since: ?
      • category: ?
      • unknownTags: ?
    • classOrInterface — 同名的类或接口
      • declaredType: Type — 声明的类型
      • typeParameters: array — 所有类型参数
        • raw: TypeParameter — 原始符号
        • name: string — 参数名
        • summary: string — 概述
        • constraintType: DocType — 约束类型
        • defaultType: DocType — 默认类型
      • extends: DocType[] — 继承类型
      • implements: DocType[] — 实现类型
      • members: DocMember[] — 所有成员（含继承的成员）
      • memberType: DocMemberType.class | DocMemberType.interface — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • namespace — 同名的命名空间
      • members: DocMember[] — 所有导出的成员
      • memberType: DocMemberType.namespace | DocMemberType.module — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • memberType: DocMemberType.function | DocMemberType.constructor | DocMemberType.method | DocMemberType.index | DocMemberType.call — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocFunction
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 34 行)    renderDocFunctionBody保护

    渲染一个函数或方法主体

    参数
    参数名说明类型
    member

    要渲染的成员

    展开子属性
    • typeParameters: array — 所有类型参数
      • raw: TypeParameter — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • constraintType: DocType — 约束类型
      • defaultType: DocType — 默认类型
    • parameters: array — 所有参数
      • raw: Symbol — 原始符号
      • name: string — 参数名
      • summary: string — 概述
      • rest: boolean — 是否是展开参数
      • optional: boolean — 是否可选
      • type: DocType — 参数类型
      • defaultValue: Expression — 默认值
      • subParameters: array — 所有子参数
        • name: string — 参数名
        • summary: string — 概述
        • rest: boolean — 是否是展开参数
        • optional: boolean — 是否可选
        • type: DocType — 参数类型
        • defaultValue: Expression — 默认值
        • subParameters: (Circular)Pick<DocParameter, "name" | "summary" | "rest" | "optional" | "type" | "defaultValue" | "subParameters">[] — 所有子参数
    • returnType: DocType — 返回值类型
    • returnSummary: string — 返回值描述
    • overloads: array — 方法的多个重载
      • raw: ?
      • declaration: ?
      • name: ?
      • summary: ?
      • defaultValue: ?
      • typeParameters: ?
      • parameters: ?
      • returnType: ?
      • returnSummary: ?
      • memberType: ?
      • sourceLocation: ?
      • id: ?
      • modifiers: ?
      • parentMember: ?
      • baseMember: ?
      • overridingMember: ?
      • ignore: ?
      • deprecatedMessage: ?
      • description: ?
      • examples: ?
      • seeAlso: ?
      • since: ?
      • category: ?
      • unknownTags: ?
    • classOrInterface — 同名的类或接口
      • declaredType: Type — 声明的类型
      • typeParameters: array — 所有类型参数
        • raw: TypeParameter — 原始符号
        • name: string — 参数名
        • summary: string — 概述
        • constraintType: DocType — 约束类型
        • defaultType: DocType — 默认类型
      • extends: DocType[] — 继承类型
      • implements: DocType[] — 实现类型
      • members: DocMember[] — 所有成员（含继承的成员）
      • memberType: DocMemberType.class | DocMemberType.interface — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • namespace — 同名的命名空间
      • members: DocMember[] — 所有导出的成员
      • memberType: DocMemberType.namespace | DocMemberType.module — 成员的类型
      • raw: Symbol — 原始符号
      • declaration: Declaration — 原始声明节点
      • sourceLocation — 源码位置
        • sourcePath: string — 源文件绝对路径
        • start: number — 源文件中的开始索引(从 0 开始)
        • end: number — 源文件中的结束索引(从 0 开始)
        • line: number — 源文件中的开始行号(从 0 开始)
        • column: number — 源文件中的开始列号(从 0 开始)
        • endLine: number — 源文件中的结束行号(从 0 开始)
        • endColumn: number — 源文件中的结束列号(从 0 开始)
      • name: string — 成员的名字
      • id: string — 成员的唯一标识
      • modifiers: DocMemberModifiers — 成员的修饰符
      • parentMember: DocMember — 声明当前成员的容器成员
      • baseMember: DocMember — 继承的父类成员
      • overridingMember: DocMember — 覆盖的父类同名成员
      • ignore: boolean — 是否忽略当前成员
      • deprecatedMessage: string — 废弃后的提示文案
      • summary: string — 概述
      • description: string — 详细说明
      • examples: string[] — 示例
      • seeAlso: string[] — 参考列表
      • since: string — 首次添加的版本号
      • category: string — 所在分类
      • defaultValue: string | number | Expression — 默认值
      • unknownTags: {[key: string]: string} — 未识别的其它标签
    • memberType: DocMemberType.function | DocMemberType.constructor | DocMemberType.method | DocMemberType.index | DocMemberType.call — 成员的类型
    • raw: Symbol — 原始符号
    • declaration: Declaration — 原始声明节点
    • sourceLocation — 源码位置
      • sourcePath: string — 源文件绝对路径
      • start: number — 源文件中的开始索引(从 0 开始)
      • end: number — 源文件中的结束索引(从 0 开始)
      • line: number — 源文件中的开始行号(从 0 开始)
      • column: number — 源文件中的开始列号(从 0 开始)
      • endLine: number — 源文件中的结束行号(从 0 开始)
      • endColumn: number — 源文件中的结束列号(从 0 开始)
    • name: string — 成员的名字
    • id: string — 成员的唯一标识
    • modifiers: DocMemberModifiers — 成员的修饰符
    • parentMember: DocMember — 声明当前成员的容器成员
    • baseMember: DocMember — 继承的父类成员
    • overridingMember: DocMember — 覆盖的父类同名成员
    • ignore: boolean — 是否忽略当前成员
    • deprecatedMessage: string — 废弃后的提示文案
    • summary: string — 概述
    • description: string — 详细说明
    • examples: string[] — 示例
    • seeAlso: string[] — 参考列表
    • since: string — 首次添加的版本号
    • category: string — 所在分类
    • defaultValue: string | number | Expression — 默认值
    • unknownTags: {[key: string]: string} — 未识别的其它标签
    		DocFunction
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 18 行)    renderDocTypeParameterList保护

    渲染类型参数列表

    参数
    参数名说明类型
    typeParameters

    类型列表

    展开子属性
    • raw: TypeParameter — 原始符号
    • name: string — 参数名
    • summary: string — 概述
    • constraintType: DocType — 约束类型
    • defaultType: DocType — 默认类型
    		DocTypeParameter[]
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 41 行)    renderDocParameterList保护

    渲染参数列表

    参数
    参数名说明类型
    parameters
    展开子属性
    • raw: Symbol — 原始符号
    • name: string — 参数名
    • summary: string — 概述
    • rest: boolean — 是否是展开参数
    • optional: boolean — 是否可选
    • type: DocType — 参数类型
    • defaultValue: Expression — 默认值
    • subParameters: array — 所有子参数
      • name: string — 参数名
      • summary: string — 概述
      • rest: boolean — 是否是展开参数
      • optional: boolean — 是否可选
      • type: DocType — 参数类型
      • defaultValue: Expression — 默认值
      • subParameters: (Circular)Pick<DocParameter, "name" | "summary" | "rest" | "optional" | "type" | "defaultValue" | "subParameters">[] — 所有子参数
    		DocParameter[]
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 14 行)    renderDocUnknownMember保护

    渲染一个未知成员

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 23 行)    renderDocMemberHeader保护

    渲染成员头部

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    icon

    渲染的图标

    		string
    postfix

    额外显示的后缀

    		string
    preferRequested

    是否标记必填项而非可选项

    		boolean
    tocLevel

    添加到目录的等级，如果为 -1 则不添加目录

    		number
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 18 行)    renderDocMemberToolBar保护

    渲染一个工具条

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 10 行)    getSourceURL保护

    获取指定源码地址的链接

    参数
    参数名说明类型
    sourceLocation

    源码地址

    展开子属性
    • sourcePath: string — 源文件绝对路径
    • start: number — 源文件中的开始索引(从 0 开始)
    • end: number — 源文件中的结束索引(从 0 开始)
    • line: number — 源文件中的开始行号(从 0 开始)
    • column: number — 源文件中的开始列号(从 0 开始)
    • endLine: number — 源文件中的结束行号(从 0 开始)
    • endColumn: number — 源文件中的结束列号(从 0 开始)
    		DocSourceLocation
    返回值
    类型：string

    渲染一个指定成员的链接

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    (可选)anchorMember

    附加设置描点的成员

    默认值：member;

    		DocMember
    返回值
    类型：?

    DocCompiler查看源码
    (共 10 行)    getDocURL保护

    获取指定成员文档的链接

    参数
    参数名说明类型
    sourceLocation

    源码地址

    展开子属性
    • sourcePath: string — 源文件绝对路径
    • start: number — 源文件中的开始索引(从 0 开始)
    • end: number — 源文件中的结束索引(从 0 开始)
    • line: number — 源文件中的开始行号(从 0 开始)
    • column: number — 源文件中的开始列号(从 0 开始)
    • endLine: number — 源文件中的结束行号(从 0 开始)
    • endColumn: number — 源文件中的结束列号(从 0 开始)
    		DocSourceLocation
    返回值
    类型：string

    DocCompiler查看源码
    (共 13 行)    renderDocMemberName保护

    渲染一个成员名

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    postfix

    额外显示的后缀

    		string
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 25 行)    renderDocMemberTags保护

    渲染成员的标签

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    preferRequested

    是否标记必填项而非可选项

    		boolean
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 11 行)    renderDocMemberSummary保护

    渲染成员的概述

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 11 行)    renderDocDeprecatedMessage保护

    渲染已废弃提示

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 24 行)    renderDocMemberDetail保护

    渲染成员的详情描述

    参数
    参数名说明类型
    member

    要渲染的成员

    		DocMember
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 26 行)    renderDocExample保护

    渲染一个示例

    参数
    参数名说明类型
    example

    示例的内容

    		string
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：any

    DocCompiler查看源码
    (共 9 行)    renderDocSeeAlso保护

    渲染一个参考链接

    参数
    参数名说明类型
    seeAlso

    链接的内容

    		string
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 47 行)    parseHref保护

    解析一个链接地址

    参数
    参数名说明类型
    href

    要解析的地址

    		string
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：{href: stringlabel: string}

    DocCompiler查看源码
    (共 8 行)    renderDocType保护

    渲染一个类型

    参数
    参数名说明类型
    type

    要渲染的类型

    		DocType
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 214 行)    renderDocTypeWorker保护

    渲染类型

    参数
    参数名说明类型
    type

    要渲染的类型

    		DocType
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    depth

    遍历的深度

    		number
    rendered

    已渲染的类型

    		Set<DocType>
    返回值
    类型：any

    DocCompiler查看源码
    (共 20 行)    renderDocParameters保护

    渲染类型中的参数列表

    参数
    参数名说明类型
    parameters
    展开子属性
    • raw: Symbol — 原始符号
    • name: string — 参数名
    • summary: string — 概述
    • rest: boolean — 是否是展开参数
    • optional: boolean — 是否可选
    • type: DocType — 参数类型
    • defaultValue: Expression — 默认值
    • subParameters: array — 所有子参数
      • name: string — 参数名
      • summary: string — 概述
      • rest: boolean — 是否是展开参数
      • optional: boolean — 是否可选
      • type: DocType — 参数类型
      • defaultValue: Expression — 默认值
      • subParameters: (Circular)Pick<DocParameter, "name" | "summary" | "rest" | "optional" | "type" | "defaultValue" | "subParameters">[] — 所有子参数
    		DocParameter[]
    context
    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    depthnumber
    renderedSet<DocType>
    返回值
    类型：any

    DocCompiler查看源码
    (共 90 行)    renderDocObjectType保护

    渲染一个对象类型

    参数
    参数名说明类型
    type

    要渲染的类型

    		DocType
    context

    页面的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    depth

    遍历的深度

    		number
    rendered

    已渲染的类型

    		Set<DocType>
    返回值
    类型：any

    DocCompiler查看源码
    (共 21 行)    renderDocExpression保护

    渲染文档中的表达式

    参数
    参数名说明类型
    expression

    要渲染的表达式

    		string | number | Expression
    context

    生成 Markdown 的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：?

    DocCompiler查看源码
    (共 8 行)    renderDocMarkdown保护

    渲染文档中的 markdown 内容

    参数
    参数名说明类型
    content

    要渲染的内容

    		string
    context

    生成 Markdown 的上下文

    展开子属性
    • url: string — 当前页面的最终访问地址
    • sourceURL: string — 生成当前页面的源地址
    • errors: array — 构建当前页面时产生的错误
      • source: string — 日志的来源
      • message: string — 日志的信息
      • fileName: string — 日志相关的文件名
      • line: number — 日志相关的行号（从 0 开始）
      • column: number — 日志相关的列号（从 0 开始）
      • endLine: number — 日志相关的结束行号（从 0 开始）
      • endColumn: number — 日志相关的结束列号（从 0 开始）
      • detail: string — 日志的详情
      • codeFrame: string — 日志相关的源代码片段
      • stack: string — 错误堆栈信息
    • dependencies: (string | DependencyCallback)[] — 构建当前页面时读取的依赖路径
    • tocManager: TOCManager — 目录管理器
    • maxTOCLevel: number — 自动生成索引的最大标题等级（1-6）（默认 4）
    • narrow: boolean — 是否渲染为窄页面，窄页面适合文字多的页面
    • demoCount: number — 演示计数器
    • demoForTestCount: number — 自测用演示计数器
    • scriptCount: number — 内联脚本计数器
    • pager: boolean — 是否生成分页器
    • activeURL: string — 导航高亮的当前页地址
    • prevPage — 上一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • nextPage — 下一页地址
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • codeURL: string — 当前页面对应的 TS/JS 源码地址（如果有）
    • unitTestURL: string — 当前页面对应的单元测试源码地址（如果有）
    • docParser: TypeScriptDocParser — API 文档解析器（如果有）
    • meta — 当前页面的信息
      • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
      • injectHead: any — 额外插入的文件头部内容
      • injectFoot: any — 额外插入的文件底部内容
      • pager: boolean — 是否插入翻页器
      • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
      • narrow: boolean — 是否生成窄页面风格
      • api: boolean — 是否自动生成关联的 API 文档
      • meta: boolean — 是否显示当前文件的元信息
      • header: string — 头部内容
      • body: string — 正文内容
      • title: string — 页面标题
      • subtitle: string — 页面副标题
      • name: string — 页面名称
      • description: string — 页面描述
      • state: string — 页面状态
      • tags: string[] — 所有标签
      • keywords: string[] — 所有关键字
      • authors: array — 所有作者
        • name: string — 作者的名字
        • email: string — 作者的邮箱
        • href: string — 作者的首页
      • changeLogs: string[] — 所有修订记录
    • title: string — 当前页面的标题
    • subtitle: any — 当前页面的副标题
    • state: string — 当前页面的状态
    • tags: string[] — 所有标签
    • authors: array — 所有维护者
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    • changeLogs: array — 所有修改历史
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		DocPageContext
    返回值
    类型：HTML

    DocCompiler查看源码
    (共 30 行)    renderWaterfallList保护

    渲染多个瀑布流

    参数
    参数名说明类型
    items

    要渲染的数据

    展开子属性
    • raw: string — 当前列表项的原始内容
    • indent: number — 当前列表项的缩进数
    • checked: boolean — 当前列表项是否被勾选
    • title: string — 当前列表项的标题
    • subtitle: string — 当前列表项的副标题
    • url: string — 当前列表项的地址
    • children: array — 所有子列表项
      • raw: string — 当前列表项的原始内容
      • indent: number — 当前列表项的缩进数
      • checked: boolean — 当前列表项是否被勾选
      • title: string — 当前列表项的标题
      • subtitle: string — 当前列表项的副标题
      • url: string — 当前列表项的地址
      • children: (Circular)MarkdownListItem[] — 所有子列表项
    		MarkdownListItem[]
    baseURL

    每个目录项的根地址

    		string
    返回值
    类型：[HTML, number]

    DocCompiler查看源码
    (共 34 行)    renderWaterFall保护

    渲染一个瀑布流

    参数
    参数名说明类型
    items

    要渲染的数据

    展开子属性
    • raw: string — 当前列表项的原始内容
    • indent: number — 当前列表项的缩进数
    • checked: boolean — 当前列表项是否被勾选
    • title: string — 当前列表项的标题
    • subtitle: string — 当前列表项的副标题
    • url: string — 当前列表项的地址
    • children: array — 所有子列表项
      • raw: string — 当前列表项的原始内容
      • indent: number — 当前列表项的缩进数
      • checked: boolean — 当前列表项是否被勾选
      • title: string — 当前列表项的标题
      • subtitle: string — 当前列表项的副标题
      • url: string — 当前列表项的地址
      • children: (Circular)MarkdownListItem[] — 所有子列表项
    		MarkdownListItem[]
    baseURL

    每个目录项的根地址

    		string
    返回值
    类型：[HTML, number]

    DocCompiler查看源码
    (共 25 行)    renderWaterFallSection保护

    渲染瀑布流的一个区块

    参数
    参数名说明类型
    items

    要渲染的数据

    展开子属性
    • raw: string — 当前列表项的原始内容
    • indent: number — 当前列表项的缩进数
    • checked: boolean — 当前列表项是否被勾选
    • title: string — 当前列表项的标题
    • subtitle: string — 当前列表项的副标题
    • url: string — 当前列表项的地址
    • children: array — 所有子列表项
      • raw: string — 当前列表项的原始内容
      • indent: number — 当前列表项的缩进数
      • checked: boolean — 当前列表项是否被勾选
      • title: string — 当前列表项的标题
      • subtitle: string — 当前列表项的副标题
      • url: string — 当前列表项的地址
      • children: (Circular)MarkdownListItem[] — 所有子列表项
    		MarkdownListItem[]
    baseURL

    每个目录项的根地址

    		string
    返回值
    类型：[HTML, number]

    DocCompiler查看源码
    (共 37 行)    renderUnitTestPage保护

    渲染一个单元测试页

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：string

    DocCompiler查看源码
    (共 108 行)    renderHomePage保护

    渲染一个首页

    参数
    参数名说明类型
    url

    当前页面的地址

    		string
    返回值
    类型：string

    查看源码
    (共 66 行)    DocCompilerOptions 接口

    表示文档编译器的选项

    属性

    属性名说明类型
    baseURL

    生成的页面中引用资源的根地址

    		string
    displayName

    项目展示名，用于网站标题栏及左上角 LOGO 文案

    		string
    version

    项目版本

    		string
    versions

    其它版本链接

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link[]
    navbar

    顶部导航条链接

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    • children: array — 子菜单
      • label: string — 链接文案
      • href: string — 链接地址
      • title: string — 鼠标悬停时的工具提示
    		(Link & {children?: Link[] // 子菜单})[]
    footer

    底部链接

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link[]
    copyright

    底部版权声明

    		string
    injectHead

    生成的文档头部插入的 HTML 代码，比如 SEO 标记

    		string
    injectFoot

    生成的文档末尾插入的 HTML 代码，比如放入一些统计代码

    		string
    maxTOCLevel

    自动生成索引的最大标题等级（1-6）（默认 4）

    		number
    counter

    定制为每个标题生成序号

    		false | true | (function(counts: number[], item: TOCItem) => string)
    backToTop

    是否插入返回顶部链接

    		boolean
    introDescription

    项目描述

    		string
    introButtons

    项目描述后的按钮

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link[]
    features

    项目优势说明链接

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    • icon: string — 图标
    • description: string — 描述文案
    		(Link & {icon: string // 图标description: string // 描述文案})[]
    support

    支持/赞助链接

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link
    packageName

    发布的包名

    		string
    repository

    项目仓库地址(HTTPS 协议)

    		string
    repositoryPath

    项目根目录在仓库中的路径

    		string
    branch

    项目仓库分支

    		string
    readCommits

    读取指定文件的修改记录

    		(files: string[]) => CommitInfo[] | Promise<CommitInfo[]>

    表示一个链接配置

    属性

    属性名说明类型
    label

    链接文案

    		string
    href(可选)

    链接地址

    		string
    title(可选)

    鼠标悬停时的工具提示

    		string

    查看源码
    (共 9 行)    CommitInfo 接口

    表示提交信息

    属性

    属性名说明类型
    authorName

    作者名

    		string
    authorEmail

    作者邮箱

    		string
    date

    提交时间

    		string

    查看源码
    (共 55 行)    DocPageContext 接口

    表示一个生成一个文档页的上下文

    属性

    属性名说明类型
    url

    当前页面的最终访问地址

    		string
    sourceURL

    生成当前页面的源地址

    		string
    errors

    构建当前页面时产生的错误

    展开子属性
    • source: string — 日志的来源
    • message: string — 日志的信息
    • fileName: string — 日志相关的文件名
    • line: number — 日志相关的行号（从 0 开始）
    • column: number — 日志相关的列号（从 0 开始）
    • endLine: number — 日志相关的结束行号（从 0 开始）
    • endColumn: number — 日志相关的结束列号（从 0 开始）
    • detail: string — 日志的详情
    • codeFrame: string — 日志相关的源代码片段
    • stack: string — 错误堆栈信息
    		LogEntry[]
    dependencies

    构建当前页面时读取的依赖路径

    		(string | DependencyCallback)[]
    tocManager

    目录管理器

    		TOCManager
    demoCount

    演示计数器

    		number
    demoForTestCount

    自测用演示计数器

    		number
    scriptCount

    内联脚本计数器

    		number
    meta

    当前页面的信息

    展开子属性
    • toc: number | false | true — 是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）
    • injectHead: any — 额外插入的文件头部内容
    • injectFoot: any — 额外插入的文件底部内容
    • pager: boolean — 是否插入翻页器
    • counter: false | true | (function(counts: number[], item: TOCItem) => string) — 是否插入标题计数器
    • narrow: boolean — 是否生成窄页面风格
    • api: boolean — 是否自动生成关联的 API 文档
    • meta: boolean — 是否显示当前文件的元信息
    • header: string — 头部内容
    • body: string — 正文内容
    • title: string — 页面标题
    • subtitle: string — 页面副标题
    • name: string — 页面名称
    • description: string — 页面描述
    • state: string — 页面状态
    • tags: string[] — 所有标签
    • keywords: string[] — 所有关键字
    • authors: array — 所有作者
      • name: string — 作者的名字
      • email: string — 作者的邮箱
      • href: string — 作者的首页
    • changeLogs: string[] — 所有修订记录
    		DocPageMeta
    title

    当前页面的标题

    		string
    maxTOCLevel(可选)

    自动生成索引的最大标题等级（1-6）（默认 4）

    		number
    narrow(可选)

    是否渲染为窄页面，窄页面适合文字多的页面

    		boolean
    pager(可选)

    是否生成分页器

    		boolean
    activeURL(可选)

    导航高亮的当前页地址

    		string
    prevPage(可选)

    上一页地址

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link
    nextPage(可选)

    下一页地址

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link
    codeURL(可选)

    当前页面对应的 TS/JS 源码地址（如果有）

    		string
    unitTestURL(可选)

    当前页面对应的单元测试源码地址（如果有）

    		string
    docParser(可选)

    API 文档解析器（如果有）

    		TypeScriptDocParser
    subtitle(可选)

    当前页面的副标题

    		any
    state(可选)

    当前页面的状态

    		string
    tags(可选)

    所有标签

    		string[]
    authors(可选)

    所有维护者

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link[]
    changeLogs(可选)

    所有修改历史

    展开子属性
    • label: string — 链接文案
    • href: string — 链接地址
    • title: string — 鼠标悬停时的工具提示
    		Link[]

    查看源码
    (共 19 行)    DocPageMeta 接口

    表示文档页面的元数据

    继承：MarkdownMeta

    属性

    属性名说明类型
    toc(可选)

    是否生成目录，如果是数字则表示生成目录的最低标题等级（1-4）

    		number | false | true
    injectHead(可选)

    额外插入的文件头部内容

    		any
    injectFoot(可选)

    额外插入的文件底部内容

    		any
    pager(可选)

    是否插入翻页器

    		boolean
    counter(可选)

    是否插入标题计数器

    		false | true | (function(counts: number[], item: TOCItem) => string)
    narrow(可选)

    是否生成窄页面风格

    		boolean
    api(可选)

    是否自动生成关联的 API 文档

    		boolean
    meta(可选)

    是否显示当前文件的元信息

    		boolean
    继承自 MarkdownMeta 接口的属性
    属性名说明类型
    header

    头部内容

    		string
    body

    正文内容

    		string
    title(可选)

    页面标题

    		string
    subtitle(可选)

    页面副标题

    		string
    name(可选)

    页面名称

    		string
    description(可选)

    页面描述

    		string
    state(可选)

    页面状态

    		string
    tags(可选)

    所有标签

    		string[]
    keywords(可选)

    所有关键字

    		string[]
    authors(可选)

    所有作者

    展开子属性
    • name: string — 作者的名字
    • email: string — 作者的邮箱
    • href: string — 作者的首页
    		{name: string // 作者的名字email?: string // 作者的邮箱href?: string // 作者的首页}[]
    changeLogs(可选)

    所有修订记录

    		string[]