codex / phpdoc
Codex 插件 - 在项目中集成 PHPDoc 文档、链接和宏
dev-master / 2.1.x-dev
2019-04-27 13:14 UTC
Requires
- codex/core: ~2.0
- jms/serializer: ~1.9
- phpdocumentor/reflection-docblock: ~3.0|~4.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.7
- graham-campbell/testbench: ~4.0
- mockery/mockery: ~0.9
- orchestra/testbench: 3.5.*
- phpunit/phpunit: ~6.0
- superbalist/flysystem-google-storage: ~5.0
Suggests
- codex/algolia-search: Integrates algolia search into codex (~2.0)
- codex/auth: Provides authentication using oauth providers (socialite) to restrict project access (~2.0)
- codex/blog: Provides blogging capability with categories containing posts (~2.0)
- codex/comments: Adds comments to your documents like Disqus or create your own adapter (~2.0)
- codex/filesystems: Adds a collection of common filesystem adapters. These can be used by your projects. (~2.0)
- codex/git: Enables Github/Bitbucket integration & synchronisation (auto-webhook or manual) based on tags/branches. (~2.0)
- codex/packagist: Integrates Packagist information links and macros in your projects (~2.0)
- codex/sitemap: Generates a sitemap.xml (~2.0)
This package is auto-updated.
Last update: 2024-09-12 00:54:43 UTC
README
Phpdoc 插件
Phpdoc 插件为 Codex 提供了解析 PHPDoc 生成的 xml 文件并以用户友好的方式显示它的手段。
安装
composer require codex/phpdoc
php artisan codex:addons:enable codex/phpdoc
php artisan vendor:publish --provider="Codex\Phpdoc\PhpdocAddonServiceProvider"
配置
...
示例
API 观看器
启用 phpdoc 的修订版允许用户浏览 API 观看器
宏
示例
<!--*codex:phpdoc:method('Codex\Phpdoc\Documents\PhpdocMacros::method()', { hide: ['namespace','tags','example'], boxed: true })*-->
链接
类链接
方法弹出窗口
版权/许可证
版权 2019 Robin Radic - MIT 许可