fantom - 如何在本地为导入的 pod 生成文档

Question

该脚本buildwebdocs.fan会为发行版的 pod 生成文档，但不会为我自己创建或导入的 pod 生成文档。如何在本地为此 pod 生成文档？

Answer 1

您可以调用compilerDoc自己：

$ fan compilerDoc -?

Usage:
  compilerDoc [options] <pods>*
Arguments:
  pods    Name of pods to compile (does not update index)
Options:
  -help, -?         Print usage help
  -all              Generate docs for every installed pods
  -allCore          Generation docs for Fantom core pods
  -clean            Delete outDir
  -outDir <File>    Output dir for doc files

因此，对于您的本地 pod：

$ fan compilerDoc myPod

Answer 2

这是一个棘手的问题，我没有直接的答案（或脚本）。但是，假设您只想查看文档并且不需要 HTML 文件目录，那么我可以提供替代方案...

安装和使用Explorer应用程序。它是一个桌面文件浏览器应用程序，其中包括一个Fandoc 查看器，可让您查看当前 Fantom 安装中 pod 中的文档。

例如，要查看afRefluxpod的文档，请afReflux在地址栏中键入（不区分大小写）：

您也可以按F1调出所有已安装 Fantom pod 的索引页面。