-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[PHPDoc] Links BeforeEvent & AfterEvent to SF's Event #377
Conversation
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
261ba88
to
f4d5061
Compare
Quality Gate passedIssues Measures |
@@ -12,6 +12,8 @@ | |||
|
|||
/** | |||
* 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
As this is outside the actual PHP API Ref
Ibexa\Contracts
scope,Symfony\Contracts\EventDispatcher\Event
isn't documented. Those@link
tags 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: