[PHPDoc] Links BeforeEvent & AfterEvent to SF's Event #377
Conversation
adriendupuis
changed the title
adriendupuis
changed the title
|
There was a problem hiding this comment.
@adriendupuis I've released code style 1.2.1. You can rebase this one against the latest 4.6 changes to also have unrelated PHPStan issues fixed.
|
@adriendupuis Could you please address issues reported by CI? |
As this is outside the actual PHP API Ref Ibexa\Contracts scope, this isn't documented. This @link can help by linking to SF repo.
adriendupuis
force-pushed
the
improved_event_phpdoc
branch
from
261ba88 to
f4d5061
Compare
|
adriendupuis
changed the title
| /** | ||
| * Event emitted after action execution. | ||
| * | ||
| * @link https://github.com/symfony/symfony/blob/5.4/src/Symfony/Contracts/EventDispatcher/Event.php Symfony\Contracts\EventDispatcher\Event |
There was a problem hiding this comment.
Maybe it would be nicer to have it inline in the description.
| * @link https://github.com/symfony/symfony/blob/5.4/src/Symfony/Contracts/EventDispatcher/Event.php Symfony\Contracts\EventDispatcher\Event | |
| * It extends {@link https://github.com/symfony/symfony/blob/5.4/src/Symfony/Contracts/EventDispatcher/Event.php Symfony\Contracts\EventDispatcher\Event}. |
|
I have an inheritance issue to fix. For example, https://doc.ibexa.co/en/master/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Events-Bookmark-CreateBookmarkEvent.html inherit the "Event emitted after action execution." description from |
|
Will be done on PHP API Ref templating side: ibexa/documentation-developer#2547 |
5 participants
As this is outside the actual PHP API Ref
Ibexa\Contractsscope,Symfony\Contracts\EventDispatcher\Eventisn't documented. Those@linktags can help.Renders as follow:
For comparison: https://doc.ibexa.co/en/master/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Event-BeforeEvent.html
Description:
For QA:
Documentation: