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/ExampleUI | |
| 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/ExampleUI')
| -rw-r--r-- | plugins/ExampleUI/API.php | 7 | ||||
| -rw-r--r-- | plugins/ExampleUI/Controller.php | 7 | ||||
| -rw-r--r-- | plugins/ExampleUI/ExampleUI.php | 12 |
3 files changed, 20 insertions, 6 deletions
diff --git a/plugins/ExampleUI/API.php b/plugins/ExampleUI/API.php index 688fe6a00f..1a606d0f16 100644 --- a/plugins/ExampleUI/API.php +++ b/plugins/ExampleUI/API.php @@ -6,8 +6,13 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik_Plugins + * @package Piwik_ExampleUI */ +/** + * @package Piwik_ExampleUI + */ class Piwik_ExampleUI_API { static private $instance = null; @@ -98,4 +103,4 @@ class Piwik_ExampleUI_API } return $planetsDataTable; } -}
\ No newline at end of file +} diff --git a/plugins/ExampleUI/Controller.php b/plugins/ExampleUI/Controller.php index 48019289a5..a1066a6abe 100644 --- a/plugins/ExampleUI/Controller.php +++ b/plugins/ExampleUI/Controller.php @@ -5,9 +5,14 @@ * @link http://piwik.org * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ - * + * + * @category Piwik_Plugins + * @package Piwik_ExampleUI */ +/** + * @package Piwik_ExampleUI + */ class Piwik_ExampleUI_Controller extends Piwik_Controller { protected function getCustomData() diff --git a/plugins/ExampleUI/ExampleUI.php b/plugins/ExampleUI/ExampleUI.php index 961b151619..fd5caf430f 100644 --- a/plugins/ExampleUI/ExampleUI.php +++ b/plugins/ExampleUI/ExampleUI.php @@ -6,10 +6,10 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik_Plugins * @package Piwik_ExampleUI */ - /* - prepare a page with all use cases - test the actions datatable in this page? @@ -19,6 +19,11 @@ - without all columns icon + update http://dev.piwik.org/trac/wiki/HowToTestUI */ + +/** + * + * @package Piwik_ExampleUI + */ class Piwik_ExampleUI extends Piwik_Plugin { public function getInformation() @@ -55,6 +60,5 @@ class Piwik_ExampleUI extends Piwik_Plugin { Piwik_AddMenu('UI Framework', $subMenu, array('module' => 'ExampleUI', 'action' => $action)); } - } - -}
\ No newline at end of file + } +} |