| title | subtitle |
|---|---|
Phpdoc |
Addons |
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
| Example | Code |
|---|---|
| Class Link | [Class Link](#codex:phpdoc['Codex\Codex']) |
| Class Link | [Class Link](#codex:phpdoc['Codex\Codex']:!styling:!icon) |
| Class Drawer + Popover | [Class Drawer + Popover](#codex:phpdoc['Codex\Codex']:drawer:popover) |
[](#codex:phpdoc['Codex\Codex']:drawer:popover) |
|
[](#codex:phpdoc['Codex\Codex']:drawer:popover:type) |
|
| Link to phpdoc class | [Link to phpdoc class](#codex:phpdoc['Codex\Codex']) |
| Link to phpdoc method | [Link to phpdoc method](#codex:phpdoc['Codex\Codex::get()']) |
| Class popover | [Class popover](#codex:phpdoc['Codex\Codex']:popover) |
[](#codex:phpdoc['Codex\Codex']:popover) |
|
| Method popover | [Method popover](#codex:phpdoc['Codex\Codex::get()']:popover) |
| Method popover + type | [Method popover + :type](#codex:phpdoc['Codex\Codex::get()']:popover::type) |
| Class type: | Class type: [](#codex:phpdoc['Codex\Codex']:type) |
| Interface type: | Interface type: [](#codex:phpdoc(Codex\Contracts\Codex):type) |
| Trait type: | Trait type: [](#codex:phpdoc(Codex\Concerns\HasCodex):type) |
| string type: | String type: [](#codex:phpdoc[string]:type) |
| array type: | Array type: [](#codex:phpdoc[array]:type) |
| Method tooltip | [Method tooltip](#codex:phpdoc['Codex\Codex::get()']:tooltip) |
| Method tooltip | [Method tooltip](#codex:phpdoc['Codex\Codex::get()']:tooltip) |
| Class | Interface | Trait | Code |
|---|---|---|---|
[](#codex:phpdoc(<name>)) |
|||
| Link | Link | Link | [Link](#codex:phpdoc(<name>)) |
[](#codex:phpdoc(<name>):!styling:!icon) |
|||
[](#codex:phpdoc(<name>):type:popover) |
|||
[](#codex:phpdoc(<name>):type:popover:drawer) |
|||
[](#codex:phpdoc(<name>):type:popover:drawer) |
Copyright/License
Copyright 2019 Robin Radic - MIT Licensed
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent