diff options
author | vipsoft <vipsoft@59fd770c-687e-43c8-a1e3-f5a4ff64c105> | 2009-08-22 17:23:16 +0400 |
---|---|---|
committer | vipsoft <vipsoft@59fd770c-687e-43c8-a1e3-f5a4ff64c105> | 2009-08-22 17:23:16 +0400 |
commit | 17648f51b30317ea27d1027dbe68eeab81ed2fa0 (patch) | |
tree | 436d3d9c8546deb59b8f307dd5b20cd1a60d407f /plugins/UserSettings | |
parent | acfca79b4d787d6ae526e4d803dc8bcc29ee78e3 (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
Diffstat (limited to 'plugins/UserSettings')
-rw-r--r-- | plugins/UserSettings/API.php | 2 | ||||
-rw-r--r-- | plugins/UserSettings/Controller.php | 5 | ||||
-rw-r--r-- | plugins/UserSettings/UserSettings.php | 2 | ||||
-rw-r--r-- | plugins/UserSettings/functions.php | 1 |
4 files changed, 10 insertions, 0 deletions
diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php index 1ec5a05e1b..7a295cb704 100644 --- a/plugins/UserSettings/API.php +++ b/plugins/UserSettings/API.php @@ -6,6 +6,7 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik_Plugins * @package Piwik_UserSettings */ @@ -15,6 +16,7 @@ defined('PIWIK_INCLUDE_PATH') or die; require_once PIWIK_INCLUDE_PATH . '/plugins/UserSettings/functions.php'; /** + * * @package Piwik_UserSettings */ class Piwik_UserSettings_API diff --git a/plugins/UserSettings/Controller.php b/plugins/UserSettings/Controller.php index f73e8dd46a..367ef275d2 100644 --- a/plugins/UserSettings/Controller.php +++ b/plugins/UserSettings/Controller.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_UserSettings */ +/** + * + * @package Piwik_UserSettings + */ class Piwik_UserSettings_Controller extends Piwik_Controller { function index() diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php index eacb1b3398..66243c7ce6 100644 --- a/plugins/UserSettings/UserSettings.php +++ b/plugins/UserSettings/UserSettings.php @@ -6,10 +6,12 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik_Plugins * @package Piwik_UserSettings */ /** + * * @package Piwik_UserSettings */ class Piwik_UserSettings extends Piwik_Plugin diff --git a/plugins/UserSettings/functions.php b/plugins/UserSettings/functions.php index 275c543bc7..b7e6f059de 100644 --- a/plugins/UserSettings/functions.php +++ b/plugins/UserSettings/functions.php @@ -6,6 +6,7 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik_Plugins * @package Piwik_UserSettings */ |