通过以下链接搜索：
frontastic / apidocs
1.0.0-rc.3
2020-05-20 05:18 UTC
Requires
- jean85/pretty-package-versions: 1.3.*
- kore/data-object: @stable
- phpdocumentor/reflection: ^4.0
- phpdocumentor/reflection-docblock: ^5.0
- symfony/yaml: ^4.4
Requires (Dev)
- pdepend/pdepend: @stable
- phploc/phploc: @stable
- phpmd/phpmd: @stable
- phpstan/phpstan: ^0.11.19
- phpunit/phpunit: ^6
- sebastian/phpcpd: @stable
- squizlabs/php_codesniffer: @stable
- symfony/swiftmailer-bundle: ^3.4
This package is auto-updated.
Last update: 2024-09-17 13:06:47 UTC
README
这个小巧的工具可以生成PHP（以及JavaScript）的API文档，以Markdown文件的形式，以便在Github和类似工具中正确渲染。该工具做了一些假设（例如：每个文件只包含一个类，类型提示优于内联文档等），以便生成的文档易于阅读。
文档目标
该工具的目标是创建简单、易读且紧凑的文档。这包括尽可能添加交叉引用，以便代码和文档易于发现。该工具试图关注相关信息，而不是尽可能输出尽可能多的信息。
我们自己的（非常无聊的）API文档也是使用此工具生成的。
配置文件
此工具的配置是通过默认名为.apidocs.yml的YAML文件进行的。您也可以在其他位置创建该文件，并将文件位置作为参数提供给bin/apidocs。配置文件中的所有路径都将相对于配置文件，如下所示：
name: "My Example project"
source: ../common/src
target: ../common/docs
autoloader: ../common/vendor/autoload.php
nameSpace: "\\My\\Example"
files: # Relative to `source`
- php/My/Class.php
- …