Merge branch 'feature/phpdoc-mismatch' of https://github.com/micheh/zf2…

… into hotfix/phpdoc
zendframework · Sep 10, 2012 · 9ac81f3 · 9ac81f3
commit 9ac81f3
Show file tree

Hide file tree

Showing 23 changed files with 65 additions and 46 deletions.
diff --git a/src/Reader/AbstractFeed.php b/src/Reader/AbstractFeed.php
@@ -72,7 +72,7 @@ abstract class AbstractFeed implements Feed\FeedInterface
     /**
      * Constructor
      *
-     * @param DomDocument The DOM object for the feed's XML
+     * @param DomDocument $domDocument The DOM object for the feed's XML
      * @param string $type Feed type
      */
     public function __construct(DOMDocument $domDocument, $type = null)

diff --git a/src/Reader/Entry/AbstractEntry.php b/src/Reader/Entry/AbstractEntry.php
@@ -39,7 +39,7 @@ abstract class AbstractEntry
     /**
      * Entry instance
      *
-     * @var Zend_Feed_Entry_Interface
+     * @var DOMElement
      */
     protected $entry = null;
 
@@ -160,7 +160,7 @@ public function getXpath()
      * Set the XPath query
      *
      * @param  DOMXPath $xpath
-     * @return Zend_Feed_Reader_Entry_EntryAbstract
+     * @return AbstractEntry
      */
     public function setXpath(DOMXPath $xpath)
     {
@@ -182,7 +182,7 @@ public function getExtensions()
      * Return an Extension object with the matching name (postfixed with _Entry)
      *
      * @param string $name
-     * @return Zend_Feed_Reader_Extension_EntryAbstract
+     * @return Reader\Extension\AbstractEntry
      */
     public function getExtension($name)
     {

diff --git a/src/Reader/Entry/EntryInterface.php b/src/Reader/Entry/EntryInterface.php
@@ -64,7 +64,7 @@ public function getDescription();
     /**
      * Get the entry enclosure
      *
-     * @return stdClass
+     * @return \stdClass
      */
     public function getEnclosure();
 

diff --git a/src/Reader/Entry/Rss.php b/src/Reader/Entry/Rss.php
@@ -71,7 +71,7 @@ public function __construct(DOMElement $entry, $entryKey, $type = null)
     /**
      * Get an author entry
      *
-     * @param DOMElement $element
+     * @param int $index
      * @return string
      */
     public function getAuthor($index = 0)
@@ -185,6 +185,7 @@ public function getDateCreated()
     /**
      * Get the entry's date of modification
      *
+     * @throws Exception\RuntimeException
      * @return string
      */
     public function getDateModified()

diff --git a/src/Reader/Extension/AbstractEntry.php b/src/Reader/Extension/AbstractEntry.php
@@ -38,7 +38,7 @@ abstract class AbstractEntry
     /**
      * Entry instance
      *
-     * @var Zend_Feed_Entry_Abstract
+     * @var DOMElement
      */
     protected $entry = null;
 

diff --git a/src/Reader/Extension/AbstractFeed.php b/src/Reader/Extension/AbstractFeed.php
@@ -166,6 +166,7 @@ public function getXpathPrefix()
     /**
      * Set the XPath prefix
      *
+     * @param string $prefix
      * @return void
      */
     public function setXpathPrefix($prefix)

diff --git a/src/Reader/Extension/Atom/Entry.php b/src/Reader/Extension/Atom/Entry.php
@@ -453,6 +453,7 @@ public function getCommentLink()
     /**
      * Returns a URI pointing to a feed of all comments for this entry
      *
+     * @param string $type
      * @return string
      */
     public function getCommentFeedLink($type = 'atom')
@@ -612,6 +613,8 @@ protected function registerNamespaces()
 
     /**
      * Detect the presence of any Atom namespaces in use
+     *
+     * @return string
      */
     protected function getAtomType()
     {

diff --git a/src/Reader/Extension/CreativeCommons/Entry.php b/src/Reader/Extension/CreativeCommons/Entry.php
@@ -22,6 +22,7 @@ class Entry extends Extension\AbstractEntry
     /**
      * Get the entry license
      *
+     * @param int $index
      * @return string|null
      */
     public function getLicense($index = 0)

diff --git a/src/Reader/Extension/CreativeCommons/Feed.php b/src/Reader/Extension/CreativeCommons/Feed.php
@@ -22,6 +22,7 @@ class Feed extends Extension\AbstractFeed
     /**
      * Get the entry license
      *
+     * @param int $index
      * @return string|null
      */
     public function getLicense($index = 0)

diff --git a/src/Reader/Extension/DublinCore/Entry.php b/src/Reader/Extension/DublinCore/Entry.php
@@ -25,7 +25,7 @@ class Entry extends Extension\AbstractEntry
     /**
      * Get an author entry
      *
-     * @param DOMElement $element
+     * @param int $index
      * @return string
      */
     public function getAuthor($index = 0)

diff --git a/src/Reader/Extension/Thread/Entry.php b/src/Reader/Extension/Thread/Entry.php
@@ -44,7 +44,6 @@ public function getCommentCount()
      * Get the entry data specified by name
      *
      * @param  string $name
-     * @param  string $type
      * @return mixed|null
      */
     protected function getData($name)

diff --git a/src/Reader/Feed/AbstractFeed.php b/src/Reader/Feed/AbstractFeed.php
@@ -11,6 +11,7 @@
 namespace Zend\Feed\Reader\Feed;
 
 use DOMDocument;
+use DOMElement;
 use DOMXPath;
 use Zend\Feed\Reader;
 use Zend\Feed\Reader\Exception;
@@ -73,7 +74,7 @@ abstract class AbstractFeed implements FeedInterface
     /**
      * Constructor
      *
-     * @param DOMDocument The DOM object for the feed's XML
+     * @param DOMDocument $domDocument The DOM object for the feed's XML
      * @param string $type Feed type
      */
     public function __construct(DOMDocument $domDocument, $type = null)
@@ -210,7 +211,7 @@ public function getType()
     /**
      * Return the current feed key
      *
-     * @return unknown
+     * @return int
      */
     public function key()
     {

diff --git a/src/Reader/Feed/Rss.php b/src/Reader/Feed/Rss.php
@@ -253,6 +253,7 @@ public function getDateModified()
     /**
      * Get the feed lastBuild date
      *
+     * @throws Exception\RuntimeException
      * @return DateTime
      */
     public function getLastBuildDate()

diff --git a/src/Reader/Reader.php b/src/Reader/Reader.php
@@ -183,13 +183,13 @@ public static function useHttpConditionalGet($bool = true)
     }
 
     /**
-     * Import a feed by providing a URL
+     * Import a feed by providing a URI
      *
-     * @param  string $url The URL to the feed
+     * @param  string $uri The URI to the feed
      * @param  string $etag OPTIONAL Last received ETag for this resource
      * @param  string $lastModified OPTIONAL Last-Modified value for this resource
      * @return Reader
-     * @throws Exception\ExceptionInterface
+     * @throws Exception\RuntimeException
      */
     public static function import($uri, $etag = null, $lastModified = null)
     {
@@ -264,6 +264,7 @@ public static function import($uri, $etag = null, $lastModified = null)
      *
      * @param  string $string
      * @return Feed\FeedInterface
+     * @throws Exception\InvalidArgumentException
      * @throws Exception\RuntimeException
      */
     public static function importString($string)
@@ -372,8 +373,10 @@ public static function findFeedLinks($uri)
      * Detect the feed type of the provided feed
      *
      * @param  Feed\AbstractFeed|DOMDocument|string $feed
+     * @param  bool $specOnly
      * @return string
-     * @throws Exception\ExceptionInterface
+     * @throws Exception\InvalidArgumentException
+     * @throws Exception\RuntimeException
      */
     public static function detectType($feed, $specOnly = false)
     {

diff --git a/src/Writer/AbstractFeed.php b/src/Writer/AbstractFeed.php
@@ -109,7 +109,7 @@ public function addAuthors(array $authors)
     /**
      * Set the copyright entry
      *
-     * @return string|null
+     * @param string $copyright
      * @throws Exception\InvalidArgumentException
      */
     public function setCopyright($copyright)
@@ -180,7 +180,7 @@ public function setLastBuildDate($date = null)
     /**
      * Set the feed description
      *
-     * @return string|null
+     * @param string $description
      * @throws Exception\InvalidArgumentException
      */
     public function setDescription($description)
@@ -194,8 +194,11 @@ public function setDescription($description)
     /**
      * Set the feed generator entry
      *
-     * @return string|null
+     * @param array|string $name
+     * @param null|string $version
+     * @param null|string $uri
      * @throws Exception\InvalidArgumentException
+     * @return string|null
      */
     public function setGenerator($name, $version = null, $uri = null)
     {
@@ -310,7 +313,7 @@ public function setImage(array $data)
     /**
      * Set the feed language
      *
-     * @return string|null
+     * @param string $language
      * @throws Exception\InvalidArgumentException
      */
     public function setLanguage($language)
@@ -338,7 +341,8 @@ public function setLink($link)
     /**
      * Set a link to an XML feed for any feed type/version
      *
-     * @return string|null
+     * @param string $link
+     * @param string $type
      * @throws Exception\InvalidArgumentException
      */
     public function setFeedLink($link, $type)
@@ -355,7 +359,7 @@ public function setFeedLink($link, $type)
     /**
      * Set the feed title
      *
-     * @return string|null
+     * @param string $title
      * @throws Exception\InvalidArgumentException
      */
     public function setTitle($title)
@@ -428,7 +432,7 @@ public function addHubs(array $urls)
     /**
      * Add a feed category
      *
-     * @param string $category
+     * @param array $category
      * @throws Exception\InvalidArgumentException
      */
     public function addCategory(array $category)
@@ -769,6 +773,7 @@ public function __call($method, $args)
     /**
      * Load extensions from Zend_Feed_Writer
      *
+     * @throws Exception\RuntimeException
      * @return void
      */
     protected function _loadExtensions()