ZF-7315: review phpDoc for API documentation generation (Zend_Queue)

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

library/Zend/Queue/Adapter/Array.php

@@ -326,8 +326,7 @@ class Zend_Queue_Adapter_Array extends Zend_Queue_Adapter_AdapterAbstract
 
     /**
      * returns underlying _data array
-     *
-     * @example $queue->getAdapter()->getData();
+     * $queue->getAdapter()->getData();
      *
      * @return $this;
      */
@@ -338,8 +337,7 @@ class Zend_Queue_Adapter_Array extends Zend_Queue_Adapter_AdapterAbstract
 
     /**
      * sets the underlying _data array
-     *
-     * @example $queue->getAdapter()->setData($data);
+     * $queue->getAdapter()->setData($data);
      *
      * @param $data array
      * @return $this;

library/Zend/Queue/Stomp/Client.php

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  * @version    $Id: Stomp.php 14504 2009-03-27 05:32:18Z danlo $
@@ -46,12 +46,12 @@ class Zend_Queue_Stomp_Client
      * @param integer port
      */
     public function __construct(
-        $scheme = null, $host = null, $port = null, 
-        $connectionClass = 'Zend_Queue_Stomp_Client_Connection', 
+        $scheme = null, $host = null, $port = null,
+        $connectionClass = 'Zend_Queue_Stomp_Client_Connection',
         $frameClass = 'Zend_Queue_Stomp_Frame'
     ) {
-        if (($scheme !== null) 
-            && ($host !== null) 
+        if (($scheme !== null)
+            && ($host !== null)
             && ($port !== null)
         ) {
             $this->addConnection($scheme, $host, $port, $connectionClass);
@@ -61,7 +61,7 @@ class Zend_Queue_Stomp_Client
 
     /**
      * Shutdown
-     * 
+     *
      * @return void
      */
     public function __destruct()
@@ -74,7 +74,7 @@ class Zend_Queue_Stomp_Client
     /**
      * Add a connection to this client.
      *
-     * Attempts to add this class to the client.  Returns a boolean value 
+     * Attempts to add this class to the client.  Returns a boolean value
      * indicating success of operation.
      *
      * You cannot add more than 1 connection to the client at this time.
@@ -105,8 +105,8 @@ class Zend_Queue_Stomp_Client
 
     /**
      * Set client connection
-     * 
-     * @param Zend_Queue_Stomp_Client_ConnectionInterface $connection 
+     *
+     * @param Zend_Queue_Stomp_Client_ConnectionInterface $connection
      * @return void
      */
     public function setConnection(Zend_Queue_Stomp_Client_ConnectionInterface $connection)
@@ -117,7 +117,7 @@ class Zend_Queue_Stomp_Client
 
     /**
      * Get client connection
-     * 
+     *
      * @return Zend_Queue_Stomp_Client_ConnectionInterface|null
      */
     public function getConnection()

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

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @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: Stomp.php 14504 2009-03-27 05:32:18Z danlo $
@@ -30,7 +30,7 @@ require_once 'Zend/Queue/Stomp/Client/ConnectionInterface.php';
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
@@ -101,8 +101,8 @@ class Zend_Queue_Stomp_Client_Connection
 
     /**
      * Close connection
-     * 
-     * @param  boolean $destructor 
+     *
+     * @param  boolean $destructor
      * @return void
      */
     public function close($destructor = false)
@@ -138,8 +138,7 @@ class Zend_Queue_Stomp_Client_Connection
 
     /**
      * Write a frame to the stomp server
-     *
-     * @example $response = $client->write($frame)->read();
+     * $response = $client->write($frame)->read();
      *
      * @param Zend_Queue_Stom_FrameInterface $frame
      * @return $this
@@ -170,10 +169,10 @@ class Zend_Queue_Stomp_Client_Connection
         $except = null;
 
         return stream_select(
-            $read, 
-            $write, 
-            $except, 
-            $this->_options['timeout_sec'], 
+            $read,
+            $write,
+            $except,
+            $this->_options['timeout_sec'],
             $this->_options['timeout_usec']
         ) == 1;
         // see http://us.php.net/manual/en/function.stream-select.php

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

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @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: Stomp.php 14504 2009-03-27 05:32:18Z danlo $
@@ -25,7 +25,7 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
@@ -41,7 +41,7 @@ interface Zend_Queue_Stomp_Client_ConnectionInterface
     public function open($scheme, $host, $port);
 
     /**
-     * @param  boolean $destructor 
+     * @param  boolean $destructor
      * @return void
      */
     public function close($destructor = false);
@@ -56,8 +56,7 @@ interface Zend_Queue_Stomp_Client_ConnectionInterface
 
     /**
      * write a frame to the stomp server
-     *
-     * @example $response = $client->write($frame)->read();
+     * $response = $client->write($frame)->read();
      *
      * @param  Zend_Queue_Stomp_FrameInterface $frame
      * @return $this

library/Zend/Queue/Stomp/Frame.php

@@ -14,24 +14,26 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @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: Stomp.php 14504 2009-03-27 05:32:18Z danlo $
  */
 
 /**
+ * @see Zend_Queue_Stomp_FrameInterface
+ */
+require_once 'Zend/Queue/Stomp/FrameInterface.php';
+
+/**
  * This class represents a Stomp Frame
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-
-require_once 'Zend/Queue/Stomp/FrameInterface.php';
-
 class Zend_Queue_Stomp_Frame
     implements Zend_Queue_Stomp_FrameInterface
 {

library/Zend/Queue/Stomp/FrameInterface.php

@@ -14,7 +14,7 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @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: Stomp.php 14504 2009-03-27 05:32:18Z danlo $
@@ -25,7 +25,7 @@
  *
  * @category   Zend
  * @package    Zend_Queue
- * @subpackage Adapter
+ * @subpackage Stomp
  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */