Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Jun 6, 2024

🎫 Issue IBX-XXXXX

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:
2024-06-06_17-43-47

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:

@adriendupuis adriendupuis changed the title Link AfterEvent to SF's Event Links Before & AfterEvent to SF's Event Jun 6, 2024
@adriendupuis adriendupuis changed the title Links Before & AfterEvent to SF's Event Links BeforeEvent & AfterEvent to SF's Event Jun 6, 2024
Copy link

sonarcloud bot commented Jun 6, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link
Member

@alongosz alongosz left a 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.

@adamwojs
Copy link
Member

@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 adriendupuis force-pushed the improved_event_phpdoc branch from 261ba88 to f4d5061 Compare November 4, 2024 16:42
Copy link

sonarcloud bot commented Nov 4, 2024

@adriendupuis adriendupuis requested a review from alongosz November 5, 2024 08:25
@adriendupuis adriendupuis marked this pull request as ready for review November 5, 2024 08:29
@adriendupuis adriendupuis changed the title Links BeforeEvent & AfterEvent to SF's Event [PHPDoc] Links BeforeEvent & AfterEvent to SF's Event Nov 5, 2024
@@ -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
Copy link
Contributor Author

@adriendupuis adriendupuis Nov 5, 2024

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.

Suggested change
* @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}.

@adriendupuis adriendupuis marked this pull request as draft November 6, 2024 16:05
@adriendupuis
Copy link
Contributor Author

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 AfterEvent. Only AfterEvent must be linked to its Symfony parent, not all its descendants.

@adriendupuis
Copy link
Contributor Author

Will be done on PHP API Ref templating side: ibexa/documentation-developer#2547

@adriendupuis adriendupuis deleted the improved_event_phpdoc branch November 21, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants