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 /core/Option.php | |
| 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 'core/Option.php')
| -rw-r--r-- | core/Option.php | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/core/Option.php b/core/Option.php index a00658eaa9..da1905dc82 100644 --- a/core/Option.php +++ b/core/Option.php @@ -6,6 +6,7 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * + * @category Piwik * @package Piwik */ @@ -17,6 +18,7 @@ * * This should not be used to store user preferences nor website preferences. * + * @package Piwik */ class Piwik_Option { @@ -40,6 +42,7 @@ class Piwik_Option /** * Returns the option value for the requested option $name + * * @param string $name * @return string|false if not found */ |