Merge pull request zendframework#490 from holtkamp/patch-1

Added more specific return documentation for Zend_Navigation Pages
anupdugar · Jan 14, 2015 · 00b6560 · 00b6560
2 parents 1f5691e + e84e6d2
commit 00b6560
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/library/Zend/Navigation/Container.php b/library/Zend/Navigation/Container.php
@@ -34,7 +34,7 @@ abstract class Zend_Navigation_Container implements RecursiveIterator, Countable
     /**
      * Contains sub pages
      *
-     * @var array
+     * @var Zend_Navigation_Page[]
      */
     protected $_pages = array();
 
@@ -143,7 +143,7 @@ public function addPage($page)
     /**
      * Adds several pages at once
      *
-     * @param  array|Zend_Config|Zend_Navigation_Container  $pages  pages to add
+     * @param  Zend_Navigation_Page[]|Zend_Config|Zend_Navigation_Container  $pages  pages to add
      * @return Zend_Navigation_Container                    fluent interface,
      *                                                      returns self
      * @throws Zend_Navigation_Exception                    if $pages is not 
@@ -178,7 +178,7 @@ public function addPages($pages)
     /**
      * Sets pages this container should have, removing existing pages
      *
-     * @param  array $pages               pages to set
+     * @param  Zend_Navigation_Page[] $pages               pages to set
      * @return Zend_Navigation_Container  fluent interface, returns self
      */
     public function setPages(array $pages)
@@ -190,7 +190,7 @@ public function setPages(array $pages)
     /**
      * Returns pages in the container
      *
-     * @return array  array of Zend_Navigation_Page instances
+     * @return Zend_Navigation_Page[]  array of Zend_Navigation_Page instances
      */
     public function getPages()
     {
@@ -359,7 +359,7 @@ public function findOneBy($property, $value, $useRegex = false)
      * @param  mixed  $value     value to match property against
      * @param  bool   $useRegex  [optional] if true PHP's preg_match is used.
      *                           Default is false.
-     * @return array             array containing only Zend_Navigation_Page
+     * @return Zend_Navigation_Page[] array containing only Zend_Navigation_Page
      *                           instances
      */
     public function findAllBy($property, $value, $useRegex = false)
@@ -484,7 +484,7 @@ public function __call($method, $arguments)
     /**
      * Returns an array representation of all pages in container
      *
-     * @return array
+     * @return Zend_Navigation_Page[]
      */
     public function toArray()
     {