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

Question

脚本 buildwebdocs.fan 为发行版的 pods 生成文档，但不为我自己制作或导入的 pods 生成文档。如何在本地为此 pods 生成文档？

Answer 1

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

安装并使用 Explorer application. It's a desktop file explorer application that, amongst other things, includes a Fandoc Viewer，让您可以在当前 Fantom 安装中查看来自 pods 的文档。

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

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

Answer 2

您可以自己调用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

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

How to generate locally the documentation for an imported pod

fantom