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

1 files changed, 19 insertions, 1 deletions

diff --git a/core/Auth.php b/core/Auth.php
index 036a0aef15..763d65215b 100644
--- a/core/Auth.php
+++ b/core/Auth.php
@@ -6,9 +6,16 @@
  * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
  * @version $Id$
  *
+ * @category Piwik
  * @package Piwik
  */
 
+/**
+ * Interface for authentication modules
+ *
+ * @package Piwik
+ * @subpackage Piwik_Auth
+ */
 interface Piwik_Auth {
 	/**
 	 * Authentication module's name, e.g., "Login"
@@ -24,8 +31,11 @@ interface Piwik_Auth {
 }
 
 /**
+ * Authentication result
  *
+ * @see Zend_Auth_Result
  * @package Piwik
+ * @subpackage Piwik_Auth
  */
 class Piwik_Auth_Result extends Zend_Auth_Result
 {
@@ -37,7 +47,15 @@ class Piwik_Auth_Result extends Zend_Auth_Result
 	protected $_token_auth = null;
 	
 	const SUCCESS_SUPERUSER_AUTH_CODE = 42;
-	
+
+	/**
+	 * Constructor for Piwik_Auth_Result
+	 *
+	 * @param int $code
+	 * @param string $login identity
+	 * @param string $token_auth
+	 * @param array $messages
+	 */
 	public function __construct($code, $login, $token_auth, array $messages = array())
 	{
 		// Piwik_Auth_Result::SUCCESS_SUPERUSER_AUTH_CODE, Piwik_Auth_Result::SUCCESS, Piwik_Auth_Result::FAILURE