README

构建共享API文档的工具，支持reStructuredText格式

对于主要API实体

我们可以生成包含在PhpDoc注释中的数据的 rst 文件。结果示例可以在这里找到：这里 .

安装

composer require patgod85/phpdoc2rst

该工具作为Symfony 2的包实现，并提供2个命令

php app/console phpdoc2rst:process

该命令为指定的目标生成 rst 文件（控制器、异常的模型）

参数

namespace - 要处理的命名空间；
path - 命名空间可以找到的路径；

选项

--output, -o - 输出 ReST 文件的路径；
--title, -t - 顶级命名空间的备用标题；
--exclude, -x - 要忽略的分号分隔的命名空间；
--target - 需要选择哪些元素。默认值 'properties'；
--groups - 允许只获取所需组的属性。用逗号分隔的字符串。默认值 ''；
--header - 为 target==properties 设置主要标题的权重。可用选项 "h1" 和 "h2"。默认值是 "h1"

php app/console phpdoc2rst:all

该命令是项目中 config.yml 配置中指定的多个 phpdoc2rst:process 的运行器

config.yml 部分示例

patgod85_phpdoc2rst:
    errors_provider: my_bundle.errors
    tasks:
        email:
            subtasks:
                default:
                    target: 'properties'
                    namespace: 'MyBundle\Model'
                    input: '%kernel.root_dir%/../src/MyBundle/Model'
                    output: '%kernel.root_dir%/../src/MyBundle/Resources/views/model'
                    groups: Export,Create
                    header: h2

对于 "properties" 模式，应计算注释 JMS\Serializer\Annotation\VirtualProperty；

##更新包

提交更改
添加带有版本号的标签
推送
在客户项目中运行 composer require patgod85/phpdoc2rst:0.0.17

patgod85 / phpdoc2rst

维护者

详细信息

README