[#21234] - PHPDoc cleanup
- Closed
- 28 Apr 2019
- Medium
- Build: staging
- # 21234
- Diff
- jonasgonka:PHPDoc_cleanup
- Success Hound No violations found. Woof! Details
- Success continuous-integration/drone/pr the build was successful Details
- Success continuous-integration/travis-ci/pr The Travis CI build passed Details
- Failure continuous-integration/appveyor/pr AppVeyor build failed Details
User tests: Successful: Unsuccessful:
Summary of Changes
Fixed some PHPDoc based on #15702 by @demis-palma, updated because some files were moved.
Some PHPDoc comments lack parameters, or indicate wrong type or number of parameters.
Others doesn't contain all necessary @throws or @return tags.
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration com_cache com_installer com_joomlaupdate com_languages com_menus com_messages com_templates com_users Templates (admin) Front End com_config Libraries Plugins Templates (site) |
| Title |
|
||||||
| Labels |
Added:
?
|
||
I have tested this item
The comments cannot cause any errors and they seem fine, so everything's alright
@icampus
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/21234.
| Status | Pending | ⇒ | Ready to Commit |
Ready to Commit after two successful tests.
@Quy Looking through the code there is a lot of inconsistencies regarding the placement of the throws parameter. The codesniffer doesn't seem to care where it is as long as it is in the docblock. I would think we should standardize the location and make it look like this:
*
* @throws \Exception
*
* @since 3.0
*/
What do you think?
https://developer.joomla.org/coding-standards/docblocks.html
Please read the Joomla Coding Standards Manual for formatting.
| Labels |
Added:
?
|
||
Please address the following regarding spaces.
Note: Commonly a line after the tag @param consists of the following three parts in order of appearance:
variable type (There must be 3 spaces before variable type.)
variable name (There must be 2 spaces after the longest type.)
variable description (There must be 2 spaces after the longest variable name.)
| Status | Ready to Commit | ⇒ | Pending |
Removed RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/21234.
| Labels |
Removed:
?
|
||
Let's close this, I don't think TS will continue with this.
| Status | Pending | ⇒ | Closed |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2019-04-28 10:42:49 |
| Closed_By | ⇒ | roland-d | |
| Labels |
Removed:
J3 Issue
|
||
@HLeithner If someone wants to take over. Sure.
I have tested this item✅ successfully on 73783ed
I tested the Patch on my local Joomla instanz. Everthing work as always fine. The code looks well the comments are usefull and i think correct. So from my side the patch is OK!
@icampus
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/21234.