[ZF-7315] Review phpDoc for API documentation generation

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

library/Zend/Amf/Value/Messaging/CommandMessage.php

@@ -43,41 +43,35 @@ class Zend_Amf_Value_Messaging_CommandMessage extends Zend_Amf_Value_Messaging_A
 {
     /**
      *  This operation is used to subscribe to a remote destination.
-     *  @const int
      */
     const SUBSCRIBE_OPERATION = 0;
 
     /**
      * This operation is used to unsubscribe from a remote destination.
-     * @const int
      */
     const UNSUSBSCRIBE_OPERATION = 1;
 
     /**
      * This operation is used to poll a remote destination for pending,
      * undelivered messages.
-     * @const int
      */
     const POLL_OPERATION = 2;
 
     /**
      * This operation is used by a remote destination to sync missed or cached messages
      * back to a client as a result of a client issued poll command.
-     * @const int
      */
     const CLIENT_SYNC_OPERATION = 4;
 
     /**
      * This operation is used to test connectivity over the current channel to
      * the remote endpoint.
-     * @const int
      */
     const CLIENT_PING_OPERATION = 5;
 
     /**
      * This operation is used to request a list of failover endpoint URIs
      * for the remote destination based on cluster membership.
-     * @const int
      */
     const CLUSTER_REQUEST_OPERATION = 7;
 
@@ -86,40 +80,34 @@ class Zend_Amf_Value_Messaging_CommandMessage extends Zend_Amf_Value_Messaging_A
      * the user can be logged in over the current channel.
      * The credentials need to be Base64 encoded and stored in the <code>body</code>
      * of the message.
-     * @const int
      */
     const LOGIN_OPERATION = 8;
 
     /**
      * This operation is used to log the user out of the current channel, and
      * will invalidate the server session if the channel is HTTP based.
-     * @const int
      */
     const LOGOUT_OPERATION = 9;
 
     /**
      * This operation is used to indicate that the client's subscription to a
      * remote destination has been invalidated.
-     * @const int
      */
     const SESSION_INVALIDATE_OPERATION = 10;
 
     /**
      * This operation is used by the MultiTopicConsumer to subscribe/unsubscribe
      * from multiple subtopics/selectors in the same message.
-     * @const int
      */
     const MULTI_SUBSCRIBE_OPERATION = 11;
 
     /**
      * This operation is used to indicate that a channel has disconnected
-     * @const int
      */
     const DISCONNECT_OPERATION = 12;
 
     /**
      * This is the default operation for new CommandMessage instances.
-     * @const int
      */
     const UNKNOWN_OPERATION = 10000;
 

library/Zend/Captcha/Base.php

@@ -19,7 +19,7 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-/** @seeZend_Captcha_Adapter */
+/** @see Zend_Captcha_Adapter */
 require_once 'Zend/Captcha/Adapter.php';
 
 /** @see Zend_Validate_Abstract */

library/Zend/Captcha/Exception.php

@@ -19,7 +19,10 @@
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-require_once ('Zend/Exception.php');
+/**
+ * @see Zend_Exception
+ */
+require_once 'Zend/Exception.php';
 
 /**
  * Exception for Zend_Form component.

library/Zend/Captcha/ReCaptcha.php

@@ -65,7 +65,6 @@ class Zend_Captcha_ReCaptcha extends Zend_Captcha_Base
 
     /**#@+
      * Error codes
-     * @const string
      */
     const MISSING_VALUE = 'missingValue';
     const ERR_CAPTCHA   = 'errCaptcha';

library/Zend/Captcha/Word.php

@@ -96,7 +96,6 @@ abstract class Zend_Captcha_Word extends Zend_Captcha_Base
 
     /**#@+
      * Error codes
-     * @const string
      */
     const MISSING_VALUE = 'missingValue';
     const MISSING_ID    = 'missingID';

library/Zend/Controller/Action/HelperBroker/PriorityStack.php

@@ -30,7 +30,6 @@
 class Zend_Controller_Action_HelperBroker_PriorityStack implements IteratorAggregate, ArrayAccess, Countable
 {
 
-    /** @protected */
     protected $_helpersByPriority = array();
     protected $_helpersByNameRef  = array();
     protected $_nextDefaultPriority = 1;

library/Zend/Db/Statement/Sqlsrv/Exception.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Db
  * @subpackage Statement
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)

library/Zend/Dojo.php

@@ -29,22 +29,22 @@
 class Zend_Dojo
 {
     /**
-     *  @const string Base path to AOL CDN
+     * Base path to AOL CDN
      */
     const CDN_BASE_AOL = 'http://o.aolcdn.com/dojo/';
 
     /**
-     * @const string Path to dojo on AOL CDN (following version string)
+     * Path to dojo on AOL CDN (following version string)
      */
     const CDN_DOJO_PATH_AOL = '/dojo/dojo.xd.js';
 
     /**
-     *  @const string Base path to Google CDN
+     * Base path to Google CDN
      */
     const CDN_BASE_GOOGLE = 'http://ajax.googleapis.com/ajax/libs/dojo/';
 
     /**
-     * @const string Path to dojo on Google CDN (following version string)
+     * Path to dojo on Google CDN (following version string)
      */
     const CDN_DOJO_PATH_GOOGLE = '/dojo/dojo.xd.js';
 

library/Zend/Dojo/View/Helper/Dojo.php

@@ -37,7 +37,7 @@ require_once 'Zend/Registry.php';
 class Zend_Dojo_View_Helper_Dojo 
 { 
     /**#@+
-     * @const Programmatic dijit creation style constants
+     * Programmatic dijit creation style constants
      */
     const PROGRAMMATIC_SCRIPT = 1;
     const PROGRAMMATIC_NOSCRIPT = -1;

library/Zend/Dom/Query.php

@@ -40,7 +40,7 @@ require_once 'Zend/Dom/Query/Result.php';
 class Zend_Dom_Query
 {
     /**#@+
-     * @const string Document types
+     * Document types
      */
     const DOC_XML   = 'docXml';
     const DOC_HTML  = 'docHtml';

library/Zend/File/Transfer/Adapter/Abstract.php

@@ -30,7 +30,7 @@
 abstract class Zend_File_Transfer_Adapter_Abstract
 {
     /**@+
-     * @const string Plugin loader Constants
+     * Plugin loader Constants
      */
     const FILTER    = 'FILTER';
     const VALIDATE  = 'VALIDATE';

library/Zend/Form/Element/Captcha.php

@@ -44,7 +44,7 @@ require_once 'Zend/Captcha/Adapter.php';
 class Zend_Form_Element_Captcha extends Zend_Form_Element_Xhtml
 {
     /**
-     * @const string Captch plugin type constant
+     * Captcha plugin type constant
      */
     const CAPTCHA = 'CAPTCHA';
 

library/Zend/Form/Element/File.php

@@ -34,7 +34,7 @@ require_once 'Zend/Form/Element/Xhtml.php';
 class Zend_Form_Element_File extends Zend_Form_Element_Xhtml
 {
     /**
-     * @const string Plugin loader type
+     * Plugin loader type
      */
     const TRANSFER_ADAPTER = 'TRANSFER_ADAPTER';
 

library/Zend/InfoCard/Adapter/Default.php

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_InfoCard
- * @subpackage Zend_InfoCard_Adapter
+ * @subpackage Adapter
  * @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$
@@ -33,7 +33,7 @@ require_once 'Zend/InfoCard/Adapter/Interface.php';
  *
  * @category   Zend
  * @package    Zend_InfoCard
- * @subpackage Zend_InfoCard_Adapter
+ * @subpackage Adapter
  * @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/InfoCard/Adapter/Exception.php

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_InfoCard
- * @subpackage Zend_InfoCard_Adapter
+ * @subpackage Adapter
  * @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$
@@ -27,7 +27,8 @@ require_once 'Zend/InfoCard/Exception.php';
 
 /**
  * @category   Zend
- * @subpackage Zend_InfoCard_Adapter
+ * @package    Zend_InfoCard
+ * @subpackage Adapter
  * @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/InfoCard/Adapter/Interface.php

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_InfoCard
- * @subpackage Zend_InfoCard_Adapter
+ * @subpackage Adapter
  * @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$
@@ -26,6 +26,7 @@
  *
  * @category   Zend
  * @package    Zend_InfoCard_Adapter
+ * @subpackage Adapter
  * @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/Json/Server.php

@@ -34,7 +34,6 @@ class Zend_Json_Server extends Zend_Server_Abstract
 {
     /**#@+
      * Version Constants
-     * @const string
      */
     const VERSION_1 = '1.0';
     const VERSION_2 = '2.0';

library/Zend/Ldap.php

@@ -463,7 +463,7 @@ class Zend_Ldap
      * @param string $name  The name to split
      * @param string $dname The resulting domain name (this is an out parameter)
      * @param string $aname The resulting account name (this is an out parameter)
-     * @retun void
+     * @return void
      */
     protected function _splitName($name, &$dname, &$aname)
     {

library/Zend/Memory.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Memory
  * @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/Memory/AccessController.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Memory
  * @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/Memory/Container.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Memory
  * @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/Memory/Exception.php

@@ -25,6 +25,7 @@ require_once 'Zend/Exception.php';
 
 
 /**
+ * @category   Zend
  * @package    Zend_Memory
  * @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/Memory/Manager.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Memory
  * @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/Memory/Value.php

@@ -26,6 +26,7 @@
  * It's an OO string wrapper.
  * Used to intercept string updates.
  *
+ * @category   Zend
  * @package    Zend_Memory
  * @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/Pdf/Outline/Loaded.php

@@ -229,7 +229,7 @@ class Zend_Pdf_Outline_Loaded extends Zend_Pdf_Outline
      * Get outline target.
      *
      * @return Zend_Pdf_Target
-     * @thows Zend_Pdf_Exception
+     * @throws Zend_Pdf_Exception
      */
     public function getTarget()
     {

library/Zend/Queue/Stomp/Client/Connection.php

@@ -145,7 +145,7 @@ class Zend_Queue_Stomp_Client_Connection
     /**
      * Write a frame to the stomp server
      *
-     * @example $response = $client->write($frame)->read();
+     * example: $response = $client->write($frame)->read();
      *
      * @param Zend_Queue_Stom_FrameInterface $frame
      * @return $this

library/Zend/Queue/Stomp/Client/ConnectionInterface.php

@@ -57,7 +57,7 @@ interface Zend_Queue_Stomp_Client_ConnectionInterface
     /**
      * write a frame to the stomp server
      *
-     * @example $response = $client->write($frame)->read();
+     * example: $response = $client->write($frame)->read();
      *
      * @param  Zend_Queue_Stomp_FrameInterface $frame
      * @return $this

library/Zend/Rest/Controller.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Rest
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
@@ -25,6 +26,7 @@ require_once 'Zend/Controller/Action.php';
  * An abstract class to guide implementation of action controllers for use with
  * Zend_Rest_Route.
  * 
+ * @category   Zend
  * @package Zend_Rest
  * @see Zend_Rest_Route
  * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)

library/Zend/Rest/Route.php

@@ -12,6 +12,7 @@
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
+ * @category   Zend
  * @package    Zend_Rest
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
@@ -43,6 +44,7 @@ require_once 'Zend/Controller/Request/Abstract.php';
  *
  * Request-aware route for RESTful modular routing
  *
+ * @category   Zend
  * @package    Zend_Rest
  * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License

library/Zend/Service/Amazon/Abstract.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Abstract
+ */
 require_once 'Zend/Service/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Abstract.php

@@ -20,10 +20,19 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Abstract
+ */
 require_once 'Zend/Service/Amazon/Abstract.php';
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Response
+ */
 require_once 'Zend/Service/Amazon/Ec2/Response.php';
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Exception
+ */
 require_once 'Zend/Service/Amazon/Ec2/Exception.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Availabilityzones.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/CloudWatch.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Ebs.php

@@ -20,9 +20,11 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
-
 /**
  * An Amazon EC2 interface to create, describe, attach, detach and delete Elastic Block
  * Storage Volumes and Snaphsots.

library/Zend/Service/Amazon/Ec2/Elasticip.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Exception.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Exception
+ */
 require_once 'Zend/Service/Amazon/Exception.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Image.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Instance.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Instance/Reserved.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Instance/Windows.php

@@ -20,15 +20,18 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**
- * Zend_Crypt_Hmac
+ * @see Zend_Crypt_Hmac
  */
 require_once 'Zend/Crypt/Hmac.php';
 
 /**
- * Zend_Json
+ * @see Zend_Json
  */
 require_once 'Zend/Json.php';
 

library/Zend/Service/Amazon/Ec2/Keypair.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Region.php

@@ -20,7 +20,11 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
+
 /**
  * An Amazon EC2 interface to query which Regions your account has access to.
  *

library/Zend/Service/Amazon/Ec2/Response.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Http_Response
+ */
 require_once 'Zend/Http/Response.php';
 
 /**

library/Zend/Service/Amazon/Ec2/Securitygroups.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Service_Amazon_Ec2_Abstract
+ */
 require_once 'Zend/Service/Amazon/Ec2/Abstract.php';
 
 /**

library/Zend/Service/Simpy.php

@@ -21,7 +21,9 @@
  * @version    $Id$
  */
 
-
+/**
+ * @see Zend_Http_Client
+ */
 require_once 'Zend/Http/Client.php';
 
 /**

library/Zend/Soap/AutoDiscover.php

@@ -20,10 +20,25 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Server_Interface
+ */
 require_once 'Zend/Server/Interface.php';
+/**
+ * @see Zend_Soap_Wsdl
+ */
 require_once 'Zend/Soap/Wsdl.php';
+/**
+ * @see Zend_Server_Reflection
+ */
 require_once 'Zend/Server/Reflection.php';
+/**
+ * @see Zend_Server_Abstract
+ */
 require_once 'Zend/Server/Abstract.php';
+/**
+ * @see Zend_Uri
+ */
 require_once 'Zend/Uri.php';
 
 /**
@@ -33,7 +48,8 @@ require_once 'Zend/Uri.php';
  * @package    Zend_Soap
  * @subpackage AutoDiscover
  */
-class Zend_Soap_AutoDiscover implements Zend_Server_Interface {
+class Zend_Soap_AutoDiscover implements Zend_Server_Interface
+{
     /**
      * @var Zend_Soap_Wsdl
      */

library/Zend/Soap/AutoDiscover/Exception.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Exception
+ */
 require_once "Zend/Exception.php";
 
 /**

library/Zend/Soap/Server.php

@@ -82,7 +82,7 @@ class Zend_Soap_Server implements Zend_Server_Interface
     /**
      * WSDL Caching Options of SOAP Server
      *
-     * @var
+     * @var mixed
      */
     protected $_wsdlCache;
 

library/Zend/Tool/Framework/Action/Repository.php

@@ -20,6 +20,9 @@
  * @version    $Id$
  */
 
+/**
+ * @see Zend_Tool_Framework_Registry_EnabledInterface
+ */
 require_once 'Zend/Tool/Framework/Registry/EnabledInterface.php';
 
 /**

library/Zend/Tool/Framework/Manifest/Repository.php

@@ -190,7 +190,7 @@ class Zend_Tool_Framework_Manifest_Repository
     /**
      * getMetadatas() - This is the main search function for the repository.
      * 
-     * @example This will retrieve all metadata that matches the following criteria
+     * example: This will retrieve all metadata that matches the following criteria
      *      $manifestRepo->getMetadatas(array(
      *          'providerName' => 'Version',
      *          'actionName' => 'show'