IBX-4929: Removed @internal param from InvalidateTokenController
#35
Conversation
This file contains hidden or 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
The constructor was tagged as internal with the reason "param string $invalidatetoken", excluding it from the phpDoc. The description make the tag looks like an old @param hidden with a trick. Move it to an internal comment to stop excluding the constructor method.
adriendupuis
commented
Mar 27, 2023
Useless as an internal comment
|
Kudos, SonarCloud Quality Gate passed!
|
Steveb-p
approved these changes
Mar 27, 2023
adamwojs
approved these changes
Mar 27, 2023
@internal param from InvalidateTokenController
alongosz
approved these changes
Mar 29, 2023
|
Thank you @adriendupuis 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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 constructor was tagged as "internal" with the reason "param string $invalidatetoken", excluding it from the phpDoc. The description make the tag looks like an old
@parammeant to be hidden. Older history I found is https://github.com/ezsystems/ezplatform-http-cache/pull/76/files#diff-745fa3232ef706c283c19d3789abcf763db490c0cc1c1bb514ec7b03a923dc22R37The tag is removed as to move it to an internal comment is useless.
https://docs.phpdoc.org/3.3/guide/references/phpdoc/tags/internal.html
TODO:
$ composer test)$ composer fix-cs).