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

时间:2017-07-09 07:04:46

标签: fantom

脚本buildwebdocs.fan生成分发广告的文档,但不是我自己或导入的广告投放文件。如何在本地为此pod生成文档?

2 个答案:

答案 0 :(得分: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

答案 1 :(得分:1)

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

安装并使用Explorer应用程序。它是一个桌面文件资源管理器应用程序,其中包括Fandoc Viewer,可让您在当前的Fantom安装中查看pod中的文档。

示例,要查看afReflux窗格的文档,请在地址栏中输入afReflux(不区分大小写):

enter image description here

您也可以按 F1 打开所有已安装的Fantom广告连播的索引页。