-
-
Notifications
You must be signed in to change notification settings - Fork 449
Fix PHPDoc {@link ...} Annotations for Rector Compatibility #4944
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
Conversation
|
No need to change? Think there is no problem with rector. (or at leeast it is solved now) See https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlinelink.pkg.html |
@sreichel - 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, 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. 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. If you consider that keeping {@link ...} it is not necessary for certain tools or internal workflows, I will close it. However, in the current context, the proposed change helps modernize the documentation without risks. |
Correct the comment formatting for the join key in $_parts.
|
I will create it again. I had to remove a lot of garbage from my fork. |
This pull request updates PHPDoc comments in the affected file(s) to remove usages of the {@link ...} inline annotation, which are not fully supported by Rector and may cause issues during automated refactoring or code analysis.
All docblocks previously containing {@link ...} are now rewritten using standard PHPDoc syntax with plain references and correct grammar, e.g.:
These updates improve compatibility with Rector and other PHPDoc tooling by ensuring all comments conform to supported annotation formats.
No business logic or code functionality was changed—only docblock comments were updated for clarity and compatibility.