Remove the usage of the {@link ...} inline annotation in PHP files #4955
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The proposed change is not intended to solve a specific issue related to Rector, but rather to modernize and simplify the PHPDoc in the code, by removing a syntax that no longer brings additional benefits in the current context.
The {@link ...} syntax is indeed part of phpDocumentor, as you can check here
https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlinelink.pkg.html
but in the files I modified, it was not used to reference URLs or classes, only for properties, which does not have a significant impact on the generated documentation. Additionally, removing this type of annotation reduces confusion and potential incompatibilities with other tools, including Rector, even if there are no errors at the moment.
I asked ChatGPT about this issue and the answer is that the {@link ...} statement is still valid, but recommends replacing it with @see.
For example:
The change is limited to a few files and does not affect the functionality of the code, only the documentation, bringing a more modern and clear form. It's a minor adjustment, but beneficial for maintenance and consistency
These updates improve compatibility with Rector and other PHPDoc tooling by ensuring all comments conform to supported annotation formats. Please note that this is only applicable to PHP files, not JavaScript files.
No business logic or code functionality was changed, only docblock comments were updated for clarity and compatibility.