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

This package is auto-updated.

Last update: 2024-10-12 01:00:30 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