Joomla! Issue Tracker - CMS

Download
Launch
Feeling Lucky

[#26395] - Namespaced classes should not have @package annotations

?
avatar mbabker
mbabker
23 Sep 2019

The use of the @package annotation is to help with grouping global classes into packages for easier consumption with tools such as phpDocumentor (which is used to generate api.joomla.org). And yet, https://api.joomla.org/cms-3/classes/Joomla.CMS.Toolbar.ToolbarHelper.html and https://api.joomla.org/cms-3/classes/Joomla.CMS.Captcha.Captcha.html both indicate they have incorrect file level doc blocks because there is a package listed.

Maybe someone should write a PHPCS sniff to prevent this error from happening again...

avatar mbabker mbabker - open - 23 Sep 2019
avatar joomla-cms-bot joomla-cms-bot - change - 23 Sep 2019
Labels Added: ?
avatar joomla-cms-bot joomla-cms-bot - labeled - 23 Sep 2019
avatar SharkyKZ
SharkyKZ - comment - 24 Sep 2019

What about class level blocks like here:

joomla-cms/libraries/src/Mail/MailWrapper.php

Lines 16 to 17 in 0433b29

* @package Joomla.Platform
* @subpackage Mail

avatar mbabker
mbabker - comment - 24 Sep 2019

Also should be killed with fire. If it is namespaced, the namespace is the package/sub package.

avatar SharkyKZ
SharkyKZ - comment - 24 Sep 2019

Test PR #26405 please.

avatar Quy Quy - change - 24 Sep 2019
Status New ⇒ Closed
Closed_Date 0000-00-00 00:00:00 ⇒ 2019-09-24 19:43:23
Closed_By ⇒ Quy
avatar Quy Quy - close - 24 Sep 2019

Add a Comment

Login with GitHub to post a comment