[Codestyle] Use @link over @see for URL's and use correct return types #15302
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
mbabker
reviewed
Apr 14, 2017
| @@ -350,7 +350,7 @@ protected function _getList($query, $limitstart = 0, $limit = 0) | |||
| * @param array $data data | |||
| * @param boolean $loadData load current data | |||
| * | |||
| * @return JForm/false the JForm object or false | |||
| * @return JForm / false the JForm object or false | |||
There was a problem hiding this comment.
Should be a pipe, JForm|false
mbabker
reviewed
Apr 14, 2017
| @@ -5,7 +5,7 @@ class Joomla_Sniffs_Commenting_SingleCommentSniff implements PHP_CodeSniffer_Sni | |||
| /** | |||
| * Returns the token types that this sniff is interested in. | |||
| * | |||
| * @return array(int) | |||
| * @return array | |||
There was a problem hiding this comment.
If this is returning an array of integers the correct annotation would be @return integer[]
mbabker
reviewed
Apr 14, 2017
| @@ -45,7 +45,7 @@ public function __construct() | |||
| /** | |||
| * Returns the patterns that this test wishes to verify. | |||
| * | |||
| * @return array(string) | |||
| * @return array | |||
There was a problem hiding this comment.
Same here, @return string[]
mbabker
reviewed
Apr 14, 2017
| @@ -319,7 +319,7 @@ public function authenticate($credentials, $options = array()) | |||
| * @param JAuthenticationResponse $response response including username of the user to authorise | |||
| * @param array $options list of options | |||
| * | |||
| * @return array[JAuthenticationResponse] results of authorisation | |||
| * @return array Array with results of authorisation containing a JAuthenticationResponse | |||
There was a problem hiding this comment.
@return JAuthenticationResponse[] Array of authentication response objects (or something like that)
|
Thanks @mbabker i have fixed the inline comments. |
|
I have tested this item ✅ successfully on 853e77d This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/15302. |
|
Thanks 👍 |
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.
Summary of Changes
Use @link over @see for URL's and use correct return types in the doc blocks
Testing Instructions
Code review as there a no production code changed
Documentation Changes Required
None
Additional Informations
I have excluded the externeal components such as fof (which has a lot of errors too) and everything in the vendor folder.