[ZF-7315] Review phpDoc for API documentation generation

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@17560 44c647ce-9c0f-0410-b52a-842ac1e357ba

library/Zend/Test/DbAdapter.php

@@ -13,7 +13,7 @@
  * to license@zend.com so we can send you a copy immediately.
  *
  * @category   Zend
- * @package    Test
+ * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
@@ -33,10 +33,9 @@ require_once "Zend/Test/DbStatement.php";
 /**
  * Testing Database Adapter which acts as a stack for SQL Results
  *
- * @uses       uses
  * @category   Zend
- * @package    package
- * @subpackage subpackage
+ * @package    Zend_Test
+ * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */

library/Zend/Test/DbStatement.php

@@ -13,13 +13,16 @@
  * to license@zend.com so we can send you a copy immediately.
  *
  * @category   Zend
- * @package    Test
+ * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Db_Statement_Interface
+ */
 require_once "Zend/Db/Statement/Interface.php";
 
 /**

library/Zend/Test/PHPUnit/Constraint/DomQuery.php

@@ -14,21 +14,23 @@
  *
  * @category   Zend
  * @package    Zend_Test
+ * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
 
-/** PHPUnit_Framework_Constraint */
+/** @see PHPUnit_Framework_Constraint */
 require_once 'PHPUnit/Framework/Constraint.php';
 
-/** Zend_Dom_Query */
+/** @see Zend_Dom_Query */
 require_once 'Zend/Dom/Query.php';
 
 /**
  * Zend_Dom_Query-based PHPUnit Constraint
  *
  * @uses       PHPUnit_Framework_Constraint
+ * @category   Zend
  * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
@@ -37,7 +39,7 @@ require_once 'Zend/Dom/Query.php';
 class Zend_Test_PHPUnit_Constraint_DomQuery extends PHPUnit_Framework_Constraint
 {
     /**#@+
-     * @const string Assertion type constants
+     * Assertion type constants
      */
     const ASSERT_QUERY            = 'assertQuery';
     const ASSERT_CONTENT_CONTAINS = 'assertQueryContentContains';

library/Zend/Test/PHPUnit/Constraint/Exception.php

@@ -14,18 +14,20 @@
  *
  * @category   Zend
  * @package    Zend_Test
+ * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
 
-/** PHPUnit_Framework_ExpectationFailedException */
+/** @see PHPUnit_Framework_ExpectationFailedException */
 require_once 'PHPUnit/Framework/ExpectationFailedException.php';
 
 /**
  * Zend_Test_PHPUnit_Constraint_Exception
  *
  * @uses       PHPUnit_Framework_ExpectationFailedException
+ * @category   Zend
  * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)

library/Zend/Test/PHPUnit/Constraint/Redirect.php

@@ -14,18 +14,20 @@
  *
  * @category   Zend
  * @package    Zend_Test
+ * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
 
-/** PHPUnit_Framework_Constraint */
+/** @see PHPUnit_Framework_Constraint */
 require_once 'PHPUnit/Framework/Constraint.php';
 
 /**
  * Redirection constraints
  *
  * @uses       PHPUnit_Framework_Constraint
+ * @category   Zend
  * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
@@ -34,7 +36,7 @@ require_once 'PHPUnit/Framework/Constraint.php';
 class Zend_Test_PHPUnit_Constraint_Redirect extends PHPUnit_Framework_Constraint
 {
     /**#@+
-     * @const string Assertion type constants
+     * Assertion type constants
      */
     const ASSERT_REDIRECT       = 'assertRedirect';
     const ASSERT_REDIRECT_TO    = 'assertRedirectTo';

library/Zend/Test/PHPUnit/Constraint/ResponseHeader.php

@@ -14,18 +14,20 @@
  *
  * @category   Zend
  * @package    Zend_Test
+ * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id$
  */
 
-/** PHPUnit_Framework_Constraint */
+/** @see PHPUnit_Framework_Constraint */
 require_once 'PHPUnit/Framework/Constraint.php';
 
 /**
  * Response header PHPUnit Constraint
  *
  * @uses       PHPUnit_Framework_Constraint
+ * @category   Zend
  * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
@@ -34,7 +36,7 @@ require_once 'PHPUnit/Framework/Constraint.php';
 class Zend_Test_PHPUnit_Constraint_ResponseHeader extends PHPUnit_Framework_Constraint
 {
     /**#@+
-     * @const string Assertion type constants
+     * Assertion type constants
      */
     const ASSERT_RESPONSE_CODE   = 'assertResponseCode';
     const ASSERT_HEADER          = 'assertHeader';

library/Zend/Test/PHPUnit/ControllerTestCase.php

@@ -19,31 +19,32 @@
  * @version    $Id$
  */
 
-/** PHPUnit_Framework_TestCase */
+/** @see PHPUnit_Framework_TestCase */
 require_once 'PHPUnit/Framework/TestCase.php';
 
-/** PHPUnit_Runner_Version */
+/** @see PHPUnit_Runner_Version */
 require_once 'PHPUnit/Runner/Version.php';
 
-/** Zend_Controller_Front */
+/** @see Zend_Controller_Front */
 require_once 'Zend/Controller/Front.php';
 
-/** Zend_Controller_Action_HelperBroker */
+/** @see Zend_Controller_Action_HelperBroker */
 require_once 'Zend/Controller/Action/HelperBroker.php';
 
-/** Zend_Layout */
+/** @see Zend_Layout */
 require_once 'Zend/Layout.php';
 
-/** Zend_Session */
+/** @see Zend_Session */
 require_once 'Zend/Session.php';
 
-/** Zend_Registry */
+/** @see Zend_Registry */
 require_once 'Zend/Registry.php';
 
 /**
  * Functional testing scaffold for MVC applications
  *
  * @uses       PHPUnit_Framework_TestCase
+ * @category   Zend
  * @package    Zend_Test
  * @subpackage PHPUnit
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)

library/Zend/Test/PHPUnit/Db/DataSet/DbRowset.php

@@ -25,6 +25,9 @@
  */
 require_once "Zend/Db/Table/Rowset/Abstract.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_AbstractTable
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/AbstractTable.php";
 
 /**

library/Zend/Test/PHPUnit/Db/DataSet/DbTable.php

@@ -20,7 +20,9 @@
  * @version    $Id$
  */
 
-
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_QueryTable
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/QueryTable.php";
 
 /**

library/Zend/Test/PHPUnit/Db/DataSet/QueryDataSet.php

@@ -20,8 +20,14 @@
  * @version    $Id$
  */
 
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_QueryDataSet
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/QueryDataSet.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
 require_once "PHPUnit/Extensions/Database/DB/IDatabaseConnection.php";
 
 /**
@@ -29,8 +35,6 @@ require_once "PHPUnit/Extensions/Database/DB/IDatabaseConnection.php";
  */
 require_once "Zend/Test/PHPUnit/Db/DataSet/QueryTable.php";
 
-
-
 /**
  * @see Zend_Db_Select
  */

library/Zend/Test/PHPUnit/Db/DataSet/QueryTable.php

@@ -20,9 +20,14 @@
  * @version    $Id$
  */
 
-
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_QueryTable
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/QueryTable.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
 require_once "PHPUnit/Extensions/Database/DB/IDatabaseConnection.php";
 
 /**

library/Zend/Test/PHPUnit/Db/Exception.php

@@ -37,5 +37,4 @@ require_once "Zend/Exception.php";
  */
 class Zend_Test_PHPUnit_Db_Exception extends Zend_Exception
 {
-    
 }

library/Zend/Test/PHPUnit/Db/Metadata/Generic.php

@@ -25,6 +25,9 @@
  */
 require_once "Zend/Db/Adapter/Abstract.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DB_IMetaData
+ */
 require_once "PHPUnit/Extensions/Database/DB/IMetaData.php";
 
 /**

library/Zend/Test/PHPUnit/Db/Operation/DeleteAll.php

@@ -20,12 +20,24 @@
  * @version    $Id$
  */
 
+/**
+ * @see PHPUnit_Extensions_Database_Operation_IDatabaseOperation
+ */
 require_once "PHPUnit/Extensions/Database/Operation/IDatabaseOperation.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
 require_once "PHPUnit/Extensions/Database/DB/IDatabaseConnection.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_IDataSet
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/IDataSet.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_Operation_Exception
+ */
 require_once "PHPUnit/Extensions/Database/Operation/Exception.php";
 
 /**

library/Zend/Test/PHPUnit/Db/Operation/Insert.php

@@ -20,12 +20,24 @@
  * @version    $Id$
  */
 
+/**
+ * @see PHPUnit_Extensions_Database_Operation_IDatabaseOperation
+ */
 require_once "PHPUnit/Extensions/Database/Operation/IDatabaseOperation.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
 require_once "PHPUnit/Extensions/Database/DB/IDatabaseConnection.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_IDataSet
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/IDataSet.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_Operation_Exception
+ */
 require_once "PHPUnit/Extensions/Database/Operation/Exception.php";
 
 /**

library/Zend/Test/PHPUnit/Db/Operation/Truncate.php

@@ -20,12 +20,24 @@
  * @version    $Id$
  */
 
+/**
+ * @see PHPUnit_Extensions_Database_Operation_IDatabaseOperation
+ */
 require_once "PHPUnit/Extensions/Database/Operation/IDatabaseOperation.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DB_IDatabaseConnection
+ */
 require_once "PHPUnit/Extensions/Database/DB/IDatabaseConnection.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_DataSet_IDataSet
+ */
 require_once "PHPUnit/Extensions/Database/DataSet/IDataSet.php";
 
+/**
+ * @see PHPUnit_Extensions_Database_Operation_Exception
+ */
 require_once "PHPUnit/Extensions/Database/Operation/Exception.php";
 
 /**