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: 2025-03-12 01:49:09 UTC
README
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