Skip to content

Conversation

addison74
Copy link
Contributor

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:

/**
 * Sets the value of _allowRenameFiles.
 * @see _allowRenameFiles
 *  ...
 */

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.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR modernizes PHPDoc comments by replacing deprecated {@link ...} inline annotations with the recommended @see tag format. The changes improve compatibility with Rector and other PHPDoc tooling while maintaining documentation clarity.

  • Replaces {@link property} syntax with @see property in docblock comments
  • Updates corresponding descriptive text to remove the inline link formatting
  • Ensures all comments conform to modern PHPDoc standards

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
lib/Varien/Io/File.php Updates docblock for _allowCreateFolders property reference
lib/Varien/File/Uploader.php Updates docblocks for three property references: _allowCreateFolders, _allowRenameFiles, and _enableFilesDispersion
lib/Varien/Db/Select.php Updates docblock for $_parts property reference

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions github-actions bot added Component: lib/Varien Relates to lib/Varien Component: lib/* Relates to lib/* labels Oct 1, 2025
Copy link

sonarqubecloud bot commented Oct 4, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: lib/Varien Relates to lib/Varien Component: lib/* Relates to lib/*
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant