diff options
author | robocoder <anthon.pang@gmail.com> | 2009-08-22 17:23:16 +0400 |
---|---|---|
committer | robocoder <anthon.pang@gmail.com> | 2009-08-22 17:23:16 +0400 |
commit | 20cac9adab214fe1e8e8a37f0cf81ec28c7968fa (patch) | |
tree | 436d3d9c8546deb59b8f307dd5b20cd1a60d407f /plugins/ExampleRssWidget | |
parent | 6eb358f25786a76f3dfcd52f40304a515cf98411 (diff) |
phpdoc cleanup:
* add @category (Piwik => 'core', Piwik_Plugins => 'plugins')
* in core, use @package and @subpackage more consistently to group files/classes; exception is DataFiles/*, PluginsFunctions/*, and SmartyPlugins/*
* in plugins, @package is the plugin name
* removed '@param none' -- not a phpdoc convention
* '@throws' and '@return void' are also not phpdoc conventions, but are widely used elsewhere, e.g., Smarty & Zend
git-svn-id: http://dev.piwik.org/svn/trunk@1420 59fd770c-687e-43c8-a1e3-f5a4ff64c105
Diffstat (limited to 'plugins/ExampleRssWidget')
-rw-r--r-- | plugins/ExampleRssWidget/ExampleRssWidget.php | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/ExampleRssWidget/ExampleRssWidget.php b/plugins/ExampleRssWidget/ExampleRssWidget.php index cb0fbb6261..7c583cefa3 100644 --- a/plugins/ExampleRssWidget/ExampleRssWidget.php +++ b/plugins/ExampleRssWidget/ExampleRssWidget.php @@ -6,9 +6,14 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik_Plugins * @package Piwik_ExampleRssWidget */ +/** + * + * @package Piwik_ExampleRssWidget + */ class Piwik_ExampleRssWidget extends Piwik_Plugin { public function getInformation() @@ -36,6 +41,10 @@ class Piwik_ExampleRssWidget extends Piwik_Plugin Piwik_AddWidget('Example Widgets', 'Piwik.org Blog', 'ExampleRssWidget', 'rssPiwik'); Piwik_AddWidget('Example Widgets', 'Piwik Changelog', 'ExampleRssWidget', 'rssChangelog'); +/** + * + * @package Piwik_ExampleRssWidget + */ class Piwik_ExampleRssWidget_Controller extends Piwik_Controller { function rssPiwik() @@ -54,6 +63,10 @@ class Piwik_ExampleRssWidget_Controller extends Piwik_Controller } } +/** + * + * @package Piwik_ExampleRssWidget + */ class Piwik_ExampleRssWidget_Rss { protected $url = null; |