糖边/sami

轻松为Sami加糖

维护者

详细信息

github.com/sugared-rim/sami

源代码

问题

安装: 11

依赖: 0

建议者: 0

安全性: 0

星标: 2

关注者: 2

分支: 1

公开问题: 0

0.5.0 2017-05-22 18:59 UTC

Requires

Requires (Dev)

MIT f1f71e2cd1dd6f6eb83998c2e6716349bff60770

  • Michael Mayer <michael.woop@schnittstabil.de>

phpdocsamisugaredpreconfiguredsugared-rim

This package is not auto-updated.

Last update: 2024-09-15 02:40:53 UTC

README

SensioLabsInsight

轻松为Sami加糖 🍒

SugaredRim\Sami 对使用 Sami 生成文档持有一种观点，它已预先配置，以便您尽可能快地开始使用。

安装

$ composer require --dev sugared-rim/sami

用法

您无需创建配置文件并运行 sami.phar update /path/to/config.php，只需运行 sugared-rim-sami 即可

{
    ...
    "require-dev": {
        "sugared-rim/sami": ...
    },
    "scripts": {
        "doc": "sugared-rim-sami"
    }
}

配置

您可以通过将选项放入您的 composer.json 中来覆盖一些选项。

一些默认设置

{
    ...
    "scripts": {
        "doc": "sugared-rim-sami"
    },
    "extra": {
        "sugared-rim/sami": {
            "files": "src",
            "filter": "SugaredRim\\Sami\\ProtectedFilter",
            "build_dir": "build/sami",
            "cache_dir": "build/cache/sami"
        }
    }
}

所有 extra.sugared-rim/sami 选项都通过 Sami构造函数 传递，除了

  • filter：要使用的过滤器的FQCN，sugared-rim-sami 将为您创建一个实例。

许可证

MIT © Michael Mayer