Fix several comments syntaxes #3615
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
Mainly wrong `@return` types in comments
Frenzie
reviewed
May 8, 2021
| * Returns the result as a JSON object. | ||
| * | ||
| * @return JSON object | ||
| * @return array |
There was a problem hiding this comment.
There's no JSON involved at all?
aledeg
reviewed
May 8, 2021
| @@ -51,7 +51,7 @@ public static function load($filename) { | |||
|
|
|||
| /** | |||
| * Return the list of sharing options. | |||
| * @return an array of FreshRSS_Share objects. | |||
| * @return array[FreshRSS_Share] | |||
There was a problem hiding this comment.
I thought the syntax was FreshRSS_Share[]
There was a problem hiding this comment.
I think there is more than one syntax, and I am not sure which is most common / best (although I think that array is more usual than []).
Feel free to change.
https://stackoverflow.com/questions/778564/phpdoc-type-hinting-for-array-of-objects/23072048#23072048
https://stackoverflow.com/questions/2713710/comment-associative-array-in-php-documentor/2725073
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.
Mainly wrong
@returntypes in comments