merged branch jakzal/domcrawler-missing-docblocks (PR #9025)

fabpot · fabpot · commit 454fbff3bdd4 · 2013-09-13T15:28:25.000+02:00
This PR was merged into the 2.2 branch. Discussion ---------- [DomCrawler] Added missing docblocks and removed redundant type in a return annotation | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- d414213 [DomCrawler] Added missing docblocks and removed unneeded return annotation.
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -84,8 +84,6 @@ public function add($node)
      *
      * @param string      $content A string to parse as HTML/XML
      * @param null|string $type    The content type of the string
-     *
-     * @return null|void
      */
     public function addContent($content, $type = null)
     {
@@ -710,6 +708,11 @@ public static function xpathLiteral($s)
         return sprintf("concat(%s)", implode($parts, ', '));
     }
 
+    /**
+     * @param integer $position
+     *
+     * @return \DOMElement|null
+     */
     private function getNode($position)
     {
         foreach ($this as $i => $node) {
@@ -723,6 +726,12 @@ private function getNode($position)
         // @codeCoverageIgnoreEnd
     }
 
+    /**
+     * @param \DOMElement $node
+     * @param string      $siblingDir
+     *
+     * @return array
+     */
     private function sibling($node, $siblingDir = 'nextSibling')
     {
         $nodes = array();

Original file line number	Diff line number	Diff line change
`@@ -84,8 +84,6 @@ public function add($node)`
`84`	`84`	`*`
`85`	`85`	`* @param string $content A string to parse as HTML/XML`
`86`	`86`	`* @param null\|string $type The content type of the string`
`87`		`- *`
`88`		`- * @return null\|void`
`89`	`87`	`*/`
`90`	`88`	`public function addContent($content, $type = null)`
`91`	`89`	`{`
`@@ -710,6 +708,11 @@ public static function xpathLiteral($s)`
`710`	`708`	`return sprintf("concat(%s)", implode($parts, ', '));`
`711`	`709`	`}`
`712`	`710`
	`711`	`+ /**`
	`712`	`+ * @param integer $position`
	`713`	`+ *`
	`714`	`+ * @return \DOMElement\|null`
	`715`	`+ */`
`713`	`716`	`private function getNode($position)`
`714`	`717`	`{`
`715`	`718`	`foreach ($this as $i => $node) {`
`@@ -723,6 +726,12 @@ private function getNode($position)`
`723`	`726`	`// @codeCoverageIgnoreEnd`
`724`	`727`	`}`
`725`	`728`
	`729`	`+ /**`
	`730`	`+ * @param \DOMElement $node`
	`731`	`+ * @param string $siblingDir`
	`732`	`+ *`
	`733`	`+ * @return array`
	`734`	`+ */`
`726`	`735`	`private function sibling($node, $siblingDir = 'nextSibling')`
`727`	`736`	`{`
`728`	`737`	`$nodes = array();`