Add @see tag to deprecated property #13301
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
orlangur
reviewed
Jan 22, 2018
| @@ -23,6 +23,7 @@ class AttributeManagement implements \Magento\Eav\Api\AttributeManagementInterfa | |||
| /** | |||
| * @var \Magento\Eav\Model\ResourceModel\Entity\Attribute\Collection | |||
| * @deprecated 100.2.0 please use instead \Magento\Eav\Model\ResourceModel\Entity\Attribute\CollectionFactory | |||
| * @see $attributeCollectionFactory | |||
There was a problem hiding this comment.
Is such tag already widely used in core code currently? Did you check that such syntax (no "class::") picked up corectly by PHPDoc parser? Ref: https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.see.pkg.html
There was a problem hiding this comment.
It's working great in IDE and it seems to be already used in the core, e.g. in File. And it is pointing out to the current class' variable.
orlangur
approved these changes
Jan 31, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Add
@seetag to deprecated property to point out the desired propertyContribution checklist