通过 
搜索
搜索facebook / hh-apidoc
此包已被废弃，不再维护。没有建议的替代包。
v0.8.0
2022-01-10 18:47 UTC
Requires
- hhvm: ^4.102
- facebook/definition-finder: ^2.13.0
- facebook/fbmarkdown: ^1.6.5
- facebook/hh-clilib: ^2.1.0
- hhvm/hhast: ^4.80
- hhvm/hsl: ^4.0
- hhvm/hsl-experimental: ^4.53
- hhvm/hsl-io: ^0.2.1|^0.3
Requires (Dev)
- hhvm/hhvm-autoload: ^2.0|^3.0
README
Hack 文件 API 文档生成器。生成器适用于以 <?hh 开头的文件。
示例
HHAPIDoc 生成自己的 API 参考文档。
项目状态
这是从 docs.hhvm.com 的文档生成器派生而来，并在那里使用了数月。
作为一个独立项目，它还不够成熟，是一个早期预览；需要在输出格式（美观度）、可用性和功能上做更多工作。查看 问题 开始。我们 欢迎贡献。
安装 hh-apidoc
- 安装 hhvm
- 安装 composer
- 将
composer.phar移动到您希望的位置。许多人将其放在家目录或全局bin目录中。 - 克隆此存储库
cd path/to/cloned/hh-apidochhvm path/to/composer.phar install- 通过
hhvm bin/hh-apidoc --help验证安装。您应该看到使用说明。
测试 hh-apidoc
运行 hh-apidoc 对自身进行测试是测试生成器的好方法
hhvm bin/hh-apidoc -o /tmp/docs ./src-o是输出结果的路径（请注意，给-o提供的路径目前必须是现有路径）。.表示使用当前目录作为源。cd /tmp/docs- 查看生成的
.html文件。您可以在您喜欢的浏览器中打开index.html来查看生成的文档。
许可
hh-apidoc 是 MIT 许可的，如 LICENSE 文件中所述。