Remove comments still referencing old Piwik_ (before using PHP 5.3 namespaces) #4609

Closed
mattab opened this Issue Feb 1, 2014 · 6 comments

3 participants

@mattab
Piwik Open Source Analytics member

I did a global search in the codebase and found hundreds of cases of Piwik_XYZ written in the codebase, mostly in comments, such as Piwik_Auth, Piwik_Db, Piwik_API, etc.

We should remove these references and replace with correct phpdoc blocks (or simply remove).

This would conclude our effort of migrating the whole codebase from pre-namespace to full namespace support (see also: #4074 )

@anonymous-piwik-user

In b1ae26d: Removing occurences of Piwik_ in core/

  • @subpackage is deprecated
  • @package must only occur once
  • @package supports nesting (and can match the namespace)

refs #4609

@halfdan
Piwik Open Source Analytics member

It's worth reading up on http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/package.html

Both @category and @subpackage are deprecated. @package should only be used if it does not match the namespace. Also @package must not appear more than once in a file.

I suggest the following:

  • for core/ we remove @package
  • for plugins/ we use @package with the name of the plugin (and not the namespace - so Actions instead of Piwik\Plugins\Actions)

Feedback?

@anonymous-piwik-user

In f9d52ca: Remove all occurences of @package / @subpackage / @category from core/ files.

refs #4609

@anonymous-piwik-user

In 6b9ae92: Remove remaining @package/@subpackage/@category declarations from plugins/

fixes #4609

@anonymous-piwik-user

In dde7c37: Removing last Piwik_ occurences

refs #4609

@mattab
Piwik Open Source Analytics member

In 217b22b: Fixes #4609 Removing last mentions of Piwik_ -- Looking sharp now!

@mattab mattab added this to the 2.1 - Piwik 2.1 milestone Jul 8, 2014
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@halfdan halfdan Removing occurences of Piwik_ in core/
  * @subpackage is deprecated
  * @package must only occur once
  * @package supports nesting (and can match the namespace)

refs #4609
b1ae26d
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@halfdan halfdan Remove all occurences of @package / @subpackage / @category from core…
…/ files.

refs #4609
f9d52ca
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@halfdan halfdan Remove remaining @package/@subpackage/@category declarations from plu…
…gins/

fixes #4609
6b9ae92
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@halfdan halfdan Removing last Piwik_ occurences
refs #4609
dde7c37
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment