Merge pull request zendframework/zendframework#2144 from PHPGangsta/f…

…ixes/phpdocClassesAndNamespaces fixed a lot of phpDoc comments
zendframework · Aug 11, 2012 · eadb29a · eadb29a
commit eadb29a
Show file tree

Hide file tree

Showing 29 changed files with 9 additions and 34 deletions.
diff --git a/src/Reader/AbstractEntry.php b/src/Reader/AbstractEntry.php
@@ -37,7 +37,7 @@ abstract class AbstractEntry
     /**
      * Entry instance
      *
-     * @var Zend\Feed\Entry
+     * @var DOMElement
      */
     protected $entry = null;
 
@@ -67,8 +67,7 @@ abstract class AbstractEntry
      *
      * @param  DOMElement $entry
      * @param  int $entryKey
-     * @param  string $type
-     * @return void
+     * @param  null|string $type
      */
     public function __construct(DOMElement $entry, $entryKey, $type = null)
     {
@@ -78,7 +77,7 @@ public function __construct(DOMElement $entry, $entryKey, $type = null)
         if ($type !== null) {
             $this->data['type'] = $type;
         } else {
-            $this->data['type'] = Reader::detectType($feed);
+            $this->data['type'] = Reader::detectType($entry);
         }
         $this->_loadExtensions();
     }
@@ -157,7 +156,7 @@ public function getXpath()
      * Set the XPath query
      *
      * @param  DOMXPath $xpath
-     * @return Zend\Feed\Reader\AbstractEntry
+     * @return \Zend\Feed\Reader\AbstractEntry
      */
     public function setXpath(DOMXPath $xpath)
     {

diff --git a/src/Reader/AbstractFeed.php b/src/Reader/AbstractFeed.php
@@ -127,7 +127,7 @@ public function count()
     /**
      * Return the current entry
      *
-     * @return \Zend\Feed\Reader\Entry
+     * @return \Zend\Feed\Reader\AbstractEntry
      */
     public function current()
     {

diff --git a/src/Reader/Entry/AbstractEntry.php b/src/Reader/Entry/AbstractEntry.php
@@ -70,7 +70,6 @@ abstract class AbstractEntry
      * @param  DOMElement $entry
      * @param  int $entryKey
      * @param  string $type
-     * @return void
      */
     public function __construct(DOMElement $entry, $entryKey, $type = null)
     {

diff --git a/src/Reader/Entry/Atom.php b/src/Reader/Entry/Atom.php
@@ -33,7 +33,6 @@ class Atom extends AbstractEntry implements EntryInterface
      * @param  DOMElement $entry
      * @param  int $entryKey
      * @param  string $type
-     * @return void
      */
     public function __construct(DOMElement $entry, $entryKey, $type = null)
     {

diff --git a/src/Reader/Entry/Rss.php b/src/Reader/Entry/Rss.php
@@ -43,7 +43,6 @@ class Rss extends AbstractEntry implements EntryInterface
      * @param  DOMElement $entry
      * @param  string $entryKey
      * @param  string $type
-     * @return void
      */
     public function __construct(DOMElement $entry, $entryKey, $type = null)
     {

diff --git a/src/Reader/Extension/AbstractEntry.php b/src/Reader/Extension/AbstractEntry.php
@@ -175,7 +175,7 @@ public function getType()
      * Set the XPath query
      *
      * @param  DOMXPath $xpath
-     * @return Reader\Reader_Extension_EntryAbstract
+     * @return AbstractEntry
      */
     public function setXpath(DOMXPath $xpath)
     {
@@ -221,7 +221,7 @@ public function getXpathPrefix()
      * Set the XPath prefix
      *
      * @param  string $prefix
-     * @return Reader\Reader_Extension_EntryAbstract
+     * @return AbstractEntry
      */
     public function setXpathPrefix($prefix)
     {

diff --git a/src/Reader/Extension/AbstractFeed.php b/src/Reader/Extension/AbstractFeed.php
@@ -125,7 +125,7 @@ public function toArray() // untested
      * Set the XPath query
      *
      * @param  DOMXPath $xpath
-     * @return Reader\Reader_Extension_EntryAbstract
+     * @return AbstractEntry
      */
     public function setXpath(DOMXPath $xpath = null)
     {

diff --git a/src/Reader/Extension/Atom/Entry.php b/src/Reader/Extension/Atom/Entry.php
@@ -521,7 +521,7 @@ public function getCategories()
     /**
      * Get source feed metadata from the entry
      *
-     * @return Reader\Reader_Feed_Atom_Source|null
+     * @return Reader\Feed\Atom\Source|null
      */
     public function getSource()
     {

diff --git a/src/Writer/AbstractFeed.php b/src/Writer/AbstractFeed.php
@@ -44,7 +44,6 @@ class AbstractFeed
      * Constructor: Primarily triggers the registration of core extensions and
      * loads those appropriate to this data container.
      *
-     * @return void
      */
     public function __construct()
     {

diff --git a/src/Writer/Entry.php b/src/Writer/Entry.php
@@ -47,7 +47,6 @@ class Entry
      * Constructor: Primarily triggers the registration of core extensions and
      * loads those appropriate to this data container.
      *
-     * @return void
      */
     public function __construct()
     {

diff --git a/src/Writer/Renderer/AbstractRenderer.php b/src/Writer/Renderer/AbstractRenderer.php
@@ -70,7 +70,6 @@ class AbstractRenderer
      * Constructor
      *
      * @param  mixed $container
-     * @return void
      */
     public function __construct($container)
     {

diff --git a/src/Writer/Renderer/Entry/Atom/Deleted.php b/src/Writer/Renderer/Entry/Atom/Deleted.php
@@ -26,7 +26,6 @@ class Deleted
      * Constructor
      *
      * @param  \Zend\Feed\Writer\Deleted $container
-     * @return void
      */
     public function __construct (\Zend\Feed\Writer\Deleted $container)
     {

diff --git a/src/Writer/Renderer/Entry/AtomDeleted.php b/src/Writer/Renderer/Entry/AtomDeleted.php
@@ -26,7 +26,6 @@ class AtomDeleted extends Renderer\AbstractRenderer implements Renderer\Renderer
      * Constructor
      *
      * @param  Writer\Deleted $container
-     * @return void
      */
     public function __construct (Writer\Deleted $container)
     {

diff --git a/src/Writer/Renderer/Entry/Rss.php b/src/Writer/Renderer/Entry/Rss.php
@@ -27,7 +27,6 @@ class Rss extends Renderer\AbstractRenderer implements Renderer\RendererInterfac
      * Constructor
      *
      * @param  Writer\Entry $container
-     * @return void
      */
     public function __construct (Writer\Entry $container)
     {

diff --git a/src/Writer/Renderer/Feed/AbstractAtom.php b/src/Writer/Renderer/Feed/AbstractAtom.php
@@ -27,7 +27,6 @@ class AbstractAtom extends Renderer\AbstractRenderer
      * Constructor
      *
      * @param  Zend_Feed_Writer_Feed $container
-     * @return void
      */
     public function __construct ($container)
     {

diff --git a/src/Writer/Renderer/Feed/Atom.php b/src/Writer/Renderer/Feed/Atom.php
@@ -24,7 +24,6 @@ class Atom extends AbstractAtom implements Renderer\RendererInterface
      * Constructor
      *
      * @param  Writer\Feed $container
-     * @return void
      */
     public function __construct (Writer\Feed $container)
     {

diff --git a/src/Writer/Renderer/Feed/Atom/AbstractAtom.php b/src/Writer/Renderer/Feed/Atom/AbstractAtom.php
@@ -26,7 +26,6 @@ class AbstractAtom extends Feed\Writer\Renderer\AbstractRenderer
      * Constructor
      *
      * @param  \Zend\Feed\Writer\Feed $container
-     * @return void
      */
     public function __construct ($container)
     {

diff --git a/src/Writer/Renderer/Feed/Atom/Source.php b/src/Writer/Renderer/Feed/Atom/Source.php
@@ -24,7 +24,6 @@ class Source extends AbstractAtom implements \Zend\Feed\Writer\Renderer\Renderer
      * Constructor
      *
      * @param  \Zend\Feed\Writer\Source $container
-     * @return void
      */
     public function __construct (\Zend\Feed\Writer\Source $container)
     {

diff --git a/src/Writer/Renderer/Feed/AtomSource.php b/src/Writer/Renderer/Feed/AtomSource.php
@@ -26,7 +26,6 @@ class AtomSource extends AbstractAtom implements Renderer\RendererInterface
      * Constructor
      *
      * @param  Zend_Feed_Writer_Feed_Source $container
-     * @return void
      */
     public function __construct (Writer\Source $container)
     {

diff --git a/src/Writer/Renderer/Feed/Rss.php b/src/Writer/Renderer/Feed/Rss.php
@@ -28,7 +28,6 @@ class Rss extends Renderer\AbstractRenderer implements Renderer\RendererInterfac
      * Constructor
      *
      * @param  Zend_Feed_Writer_Feed $container
-     * @return void
      */
     public function __construct (Writer\Feed $container)
     {

diff --git a/test/Reader/Entry/_files/Common/atom.xml b/test/Reader/Entry/_files/Common/atom.xml
@@ -525,7 +525,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Entry/_files/Common/atom_noencodingdefined.xml b/test/Reader/Entry/_files/Common/atom_noencodingdefined.xml
@@ -525,7 +525,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Entry/_files/Common/rss.xml b/test/Reader/Entry/_files/Common/rss.xml
@@ -504,7 +504,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Feed/_files/Common/atom.xml b/test/Reader/Feed/_files/Common/atom.xml
@@ -525,7 +525,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Feed/_files/Common/atom_noencodingdefined.xml b/test/Reader/Feed/_files/Common/atom_noencodingdefined.xml
@@ -525,7 +525,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Feed/_files/Common/atom_rewrittenbydom.xml b/test/Reader/Feed/_files/Common/atom_rewrittenbydom.xml
@@ -521,7 +521,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Feed/_files/Common/rss.xml b/test/Reader/Feed/_files/Common/rss.xml
@@ -504,7 +504,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Integration/_files/wordpress-atom10.xml b/test/Reader/Integration/_files/wordpress-atom10.xml
@@ -525,7 +525,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {

diff --git a/test/Reader/Integration/_files/wordpress-rss2-dc-atom.xml b/test/Reader/Integration/_files/wordpress-rss2-dc-atom.xml
@@ -504,7 +504,6 @@ class Wp_Amf_Gateway
      *
      * @param array $dbConfig
      * @param string $prefix
-     * @return void
      */
     public function __construct(array $dbConfig, $prefix)
     {