@appium/typedoc-plugin-appium

类型文件插件 辅料 其扩展( h)

概览

此套件的杠杆 类型文件 为 Appium v2+ 驱动器和插件生成命令文档(HTTP端点、有效载荷信息等).

重要说明

如果您是 Appium 扩展作者并只想构建 HTML 文档, (中文(简体) ), 不要直接安装这个--而不是,安装 @appium/docutils,这是一个为您配置一切的更高级的软件包.

狦 仅限 要为您的扩展构建标记下的文件, 您可以直接使用此软件包 .

安装

npm v8+需要安装此软件包.

npm install @appium/typedoc-plugin-appium --save-dev

上述命令会安装插件以及所有必要的对等关系依赖。 见 package.json 用于完整依赖列表.

使用量

类型 Doc 通过一个 typedoc.json 或者说 typedoc.js 文件( 编号读取文件 更多信息).

一个 Appium 扩展作者希望为扩展生成标记下文档,需要创建 typedoc.json. 至少应包括:

{
  "entryPointStrategy": "packages",
  "entryPoints": ["."],
  "name": "<name of extension>",
  "theme": "appium",
  "out": "<path to output directory>"
}

此文件一旦创建, 您可以运行 typedoc 生成文档,并将输出到 out 上面配置的目录.

选项

此插件支持来自 类型doc- 插件- 标记下,以及以下内容:

outputModules

boolean - 除了命令文档之外,输出模块、类、接口和其他类型的信息(通常的TypeDoc输出)。 这对各种类型的完整记录是必要的. 默认值 : true

outputBuiltinCommands

boolean - 产出 全部 命令和类型来自 Appium 内建 - 不只是您的扩展 。 其用意为Appium本身. 默认值 : false

packageTitles

Array<{name: string, title: string}>: 含有模块名称的对象阵列 name 显示名称 title。默认情况下,标题使用模块名称;使用此名称来推翻该行为. 默认值 : undefined

commandsDir

string - “命令”目录相对于类型Doc输出目录的名称(out) (中文(简体) ). 默认值 : commands

forceBreadcrumbs

boolean - 强迫面包屑输出 hideBreadcrumbs 从 typedoc-plugin-markdown。 。 。 . 默认值 : false

发展

这个软件包使用快照测试来断言生成的平分值是正确的. 如果您做了影响插件输出的修改, 您需要更新快照 .

要更新快照, 执行 :

UPDATE_SNAPSHOT=1 npm run test:e2e

这将( 可能) 修改您工作副本中的快照, 因此您需要执行 .

许可证

版权所有 2022 OpenJS 基金会. 许可的 Apache-2.0