Php doc fixes

lib/Doctrine/Event.php

@@ -328,8 +328,8 @@ public function getSequence()
      * getInvoker
      * returns the handler that invoked this event
      *
-     * @return Doctrine_Connection|Doctrine_Connection_Statement|
-     *         Doctrine_Connection_UnitOfWork|Doctrine_Transaction   the handler that invoked this event
+     * @return Doctrine_Record|Doctrine_Connection|Doctrine_Connection_Statement|
+     *                       Doctrine_Connection_UnitOfWork|Doctrine_Transaction   the handler that invoked this event
      */
     public function getInvoker()
     {

lib/Doctrine/Query.php

@@ -272,9 +272,10 @@ public function fetchArray($params = array())
      * Convenience method to execute the query and return the first item
      * of the collection.
      *
-     * @param string $params        Query parameters
-     * @param int $hydrationMode    Hydration mode: see Doctrine_Core::HYDRATE_* constants
-     * @return array|Doctrine_Record      Array or Doctrine_Record, depending on hydration mode. False if no result.
+     * @param array $params        Query parameters
+     * @param int   $hydrationMode Hydration mode: see Doctrine_Core::HYDRATE_* constants
+     *
+     * @return array|Doctrine_Record|false Array or Doctrine_Collection, depending on hydration mode. False if no result.
      */
     public function fetchOne($params = array(), $hydrationMode = null)
     {

lib/Doctrine/Record.php

@@ -962,7 +962,8 @@ public function state($state = null)
      *
      * @throws Doctrine_Record_Exception        When the refresh operation fails (when the database row
      *                                          this record represents does not exist anymore)
-     * @return boolean
+     *
+     * @return false|Doctrine_Record false if the record is not saved yet
      */
     public function refresh($deep = false)
     {
@@ -1013,10 +1014,8 @@ public function refresh($deep = false)
      * refresh
      * refresh data of related objects from the database
      *
-     * @param string $name              name of a related component.
-     *                                  if set, this method only refreshes the specified related component
-     *
-     * @return Doctrine_Record          this object
+     * @param string $name name of a related component. if set, this method only refreshes
+     *                     the specified related component
      */
     public function refreshRelated($name = null)
     {

lib/Doctrine/Record/Abstract.php

@@ -61,7 +61,7 @@ public function getTable()
     /**
      * addListener
      *
-     * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
+     * @param Doctrine_EventListener_Interface|Doctrine_Overloadable|Doctrine_Record_Listener_Interface $listener
      * @return Doctrine_Record
      */
     public function addListener($listener, $name = null)
@@ -74,7 +74,7 @@ public function addListener($listener, $name = null)
     /**
      * getListener
      *
-     * @return Doctrine_EventListener_Interface|Doctrine_Overloadable
+     * @return Doctrine_EventListener_Interface|Doctrine_Overloadable|Doctrine_Record_Listener_Interface
      */
     public function getListener()
     {
@@ -84,7 +84,7 @@ public function getListener()
     /**
      * setListener
      *
-     * @param Doctrine_EventListener_Interface|Doctrine_Overloadable $listener
+     * @param Doctrine_EventListener_Interface|Doctrine_Overloadable|Doctrine_Record_Listener_Interface $listener
      * @return Doctrine_Record
      */
     public function setListener($listener)

lib/Doctrine/Table.php

@@ -1495,8 +1495,9 @@ public function hasField($fieldName)
      * This method assign the connection which this table will use
      * to create queries.
      *
-     * @param Doctrine_Connection      a connection object
-     * @return Doctrine_Table           this object; fluent interface
+     * @param Doctrine_Connection $conn a connection object
+     *
+     * @return Doctrine_Table this object; fluent interface
      */
     public function setConnection(Doctrine_Connection $conn)
     {
@@ -1525,11 +1526,12 @@ public function getConnection()
      * this component. The record is not created in the database until you
      * call Doctrine_Record::save().
      *
-     * @param $array             an array where keys are field names and
-     *                           values representing field values. Can contain
-     *                           also related components;
-     *                           @see Doctrine_Record::fromArray()
-     * @return Doctrine_Record   the created record object
+     * @param array $array an array where keys are field names and
+     *                     values representing field values. Can contain
+     *                     also related components;
+     *                     @see Doctrine_Record::fromArray()
+     *
+     * @return Doctrine_Record the created record object
      */
     public function create(array $array = array())
     {
@@ -1543,9 +1545,12 @@ public function create(array $array = array())
      * Adds a named query in the query registry.
      *
      * This methods register a query object with a name to use in the future.
+     *
      * @see createNamedQuery()
-     * @param $queryKey                       query key name to use for storage
+     *
+     * @param string                $queryKey query key name to use for storage
      * @param string|Doctrine_Query $query    DQL string or object
+     *
      * @return void
      */
     public function addNamedQuery($queryKey, $query)
@@ -1591,7 +1596,8 @@ public function createNamedQuery($queryKey)
      *                            Otherwise this argument expect an array of query params.
      * @param int $hydrationMode  Optional Doctrine_Core::HYDRATE_ARRAY or Doctrine_Core::HYDRATE_RECORD if
      *                            first argument is a NamedQuery
-     * @return mixed              Doctrine_Collection, array, Doctrine_Record or false if no result
+     *
+     * @return Doctrine_Collection|array|Doctrine_Record|false Doctrine_Collection, array, Doctrine_Record or false if no result
      */
     public function find()
     {

lib/Doctrine/Template/Listener/Timestampable.php

@@ -43,8 +43,7 @@ class Doctrine_Template_Listener_Timestampable extends Doctrine_Record_Listener
     /**
      * __construct
      *
-     * @param string $options 
-     * @return void
+     * @param array $options
      */
     public function __construct(array $options)
     {
@@ -55,7 +54,6 @@ public function __construct(array $options)
      * Set the created and updated Timestampable columns when a record is inserted
      *
      * @param Doctrine_Event $event
-     * @return void
      */
     public function preInsert(Doctrine_Event $event)
     {
@@ -79,8 +77,7 @@ public function preInsert(Doctrine_Event $event)
     /**
      * Set updated Timestampable column when a record is updated
      *
-     * @param Doctrine_Event $evet
-     * @return void
+     * @param Doctrine_Event $event
      */
     public function preUpdate(Doctrine_Event $event)
     {
@@ -96,8 +93,7 @@ public function preUpdate(Doctrine_Event $event)
     /**
      * Set the updated field for dql update queries
      *
-     * @param Doctrine_Event $evet
-     * @return void
+     * @param Doctrine_Event $event
      */
     public function preDqlUpdate(Doctrine_Event $event)
     {
@@ -116,8 +112,10 @@ public function preDqlUpdate(Doctrine_Event $event)
     /**
      * Gets the timestamp in the correct format based on the way the behavior is configured
      *
-     * @param string $type 
-     * @return void
+     * @param string                   $type
+     * @param null|Doctrine_Connection $conn
+     *
+     * @return Doctrine_Expression|int|string
      */
     public function getTimestamp($type, $conn = null)
     {

lib/Doctrine/Validator/ErrorStack.php

@@ -66,8 +66,9 @@ public function __construct($className)
     /**
      * Adds an error to the stack.
      *
-     * @param string $invalidFieldName
-     * @param string $errorType
+     * @param string                           $invalidFieldName
+     * @param string|Doctrine_Validator_Driver $errorCode
+     * @throws Doctrine_Exception
      */
     public function add($invalidFieldName, $errorCode = 'general')
     {
@@ -146,7 +147,7 @@ public function clear()
     /**
      * Enter description here...
      *
-     * @return unknown
+     * @return ArrayIterator unknown
      */
     public function getIterator()
     {