Search by 
codex / phpdoc
Codex Addon - Integrates PHPDoc documentation, links and macros in your projects
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-12-12 01:23:36 UTC
README
Phpdoc Addon
The Phpdoc Addon provides Codex the means to parse the phpdoc generated xml file and display it in a user-friendly way.
Installation
composer require codex/phpdoc
php artisan codex:addons:enable codex/phpdoc
php artisan vendor:publish --provider="Codex\Phpdoc\PhpdocAddonServiceProvider"
Configuration
...
Examples
Api Viewer
Revisions with phpdoc enabled allows users to browse the Api Viewer
Macros
Example
<!--*codex:phpdoc:method('Codex\Phpdoc\Documents\PhpdocMacros::method()', { hide: ['namespace','tags','example'], boxed: true })*-->
Links
Class Link
Method popover
Copyright/License
Copyright 2019 Robin Radic - MIT Licensed