c-harris / phpquery

src/bootstrap.php

Doc Comments +13 added lines

@@ -44,6 +44,10 @@ 
  *  Included for mbstring pseudo-compatability.
  */
 if (!function_exists('mb_strpos')) {
+
+    /**
+     * @param string $needle
+     */
     function mb_strpos($haystack, $needle, $offset = 0)
     {
         return strpos($haystack, $needle, $offset);
@@ -55,6 +59,10 @@ 
  *  Included for mbstring pseudo-compatability.
  */
 if (!function_exists('mb_stripos')) {
+
+    /**
+     * @param string $needle
+     */
     function mb_stripos($haystack, $needle, $offset = 0)
     {
         return stripos($haystack, $needle, $offset);
@@ -67,6 +75,11 @@ 
  *  Included for mbstring pseudo-compatability.
  */
 if (!function_exists('mb_substr')) {
+
+    /**
+     * @param string $str
+     * @param integer $start
+     */
     function mb_substr($str, $start, $length = 0)
     {
         return substr($str, $start, $length);

src/Callback/Callback.php

Doc Comments +8 added lines

@@ -1,6 +1,14 @@
 <?php
 interface ICallbackNamed {
+
+	/**
+	 * @return boolean
+	 */
 	function hasName();
+
+	/**
+	 * @return string
+	 */
 	function getName();
 }
 /**

src/Dom/DOMDocumentWrapper.php

Doc Comments +8 added lines, -1 removed lines

@@ -592,6 +592,7 @@ 
      *
      * @param $document DOMDocumentWrapper
      * @param $markup
+     * @param DOMDocumentWrapper $fragment
      * @return $document
      */
     private function documentFragmentLoadMarkup($fragment, $charset, $markup = null)
@@ -643,6 +644,9 @@ 
         return true;
     }
 
+    /**
+     * @param DOMDocumentWrapper $fragment
+     */
     protected function documentFragmentToMarkup($fragment)
     {
         PhpQuery::debug('documentFragmentToMarkup');
@@ -760,6 +764,9 @@ 
         }
     }
 
+    /**
+     * @param string $markup
+     */
     protected static function markupFixXHTML($markup)
     {
         $markup = self::expandEmptyTag('script', $markup);
@@ -776,7 +783,7 @@ 
     /**
      * expandEmptyTag
      *
-     * @param $tag
+     * @param string $tag
      * @param $xml
      * @return string
      * @author mjaque at ilkebenson dot com

src/PhpQuery.php

Doc Comments +17 added lines, -5 removed lines

@@ -338,7 +338,7 @@ 
      * Creates new document from markup.
      * Chainable.
      *
-     * @param null $markup
+     * @param string $markup
      * @param null $charset
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
@@ -380,7 +380,7 @@ 
      * Creates new document from markup.
      * Chainable.
      *
-     * @param null   $markup
+     * @param string   $markup
      * @param string $contentType
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
@@ -571,7 +571,7 @@ 
     /**
      * Enter description here...
      *
-     * @param      $html
+     * @param      string $html
      * @param null $contentType
      * @param null $documentID
      * @return null|string
@@ -737,7 +737,7 @@ 
     /**
      * Unloades all or specified document from memory.
      *
-     * @param null $id
+     * @param string $id
      * @internal param mixed $documentID @see PhpQuery::getDocumentID() for supported types.
      */
     public static function unloadDocuments($id = null)
@@ -1128,6 +1128,9 @@ 
         self::$ajaxSettings = array_merge(self::$ajaxSettings, $options);
     }
 
+    /**
+     * @param string|false $host1
+     */
     public static function ajaxAllowHost($host1, $host2 = null, $host3 = null)
     {
         $loop = is_array($host1) ? $host1 : func_get_args();
@@ -1138,6 +1141,9 @@ 
         }
     }
 
+    /**
+     * @param string $url1
+     */
     public static function ajaxAllowURL($url1, $url2 = null, $url3 = null)
     {
         $loop = is_array($url1) ? $url1 : func_get_args();
@@ -1515,7 +1521,7 @@ 
 
     /**
      *
-     * @param $type
+     * @param string $type
      * @param $code
      * @return string
      */
@@ -1558,6 +1564,9 @@ 
         }
     }
 
+    /**
+     * @param string $documentID
+     */
     public static function data($node, $name, $data, $documentID = null)
     {
         if (!$documentID)
@@ -1579,6 +1588,9 @@ 
             return $id;
     }
 
+    /**
+     * @param string $documentID
+     */
     public static function removeData($node, $name, $documentID)
     {
         if (!$documentID)

src/PhpQueryEvents.php

Doc Comments +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
      * Binds a handler to one or more events (like click) for each matched element.
      * Can also bind custom events.
      *
-     * @param \DOMNode|PhpQueryObject|string $document
+     * @param string $document
      * @param                                $node
      * @param string                         $type
      * @param string                         $data Optional
@@ -141,7 +141,7 @@ 
     /**
      * Enter description here...
      *
-     * @param \DOMNode|PhpQueryObject|string $document
+     * @param string $document
      * @param                                $node
      * @param string                         $type
      * @param                                $callback

src/PhpQueryObject.php

Doc Comments +31 added lines, -20 removed lines

@@ -294,6 +294,7 @@ 
      * Enter description here...
      *
      * @link http://docs.jquery.com/Ajax/serializeArray
+     * @param PhpQueryObject $submit
      * @return array
      */
     public function serializeArray($submit = null)
@@ -371,7 +372,7 @@ 
      * Determines if $char is really a char.
      *
      * @param string $char
-     * @return bool
+     * @return integer
      * @todo   rewrite me to charcode range ! ;)
      * @access private
      */
@@ -719,7 +720,7 @@ 
      * contains(tokenize(@class, '\s'), "something")
      * @param string $class
      * @param string $node
-     * @return boolean
+     * @return boolean|null
      * @access private
      */
     protected function matchClasses($class, $node)
@@ -748,6 +749,8 @@ 
 
     /**
      * @access private
+     * @param string $XQuery
+     * @param string $compare
      */
     protected function runQuery($XQuery, $selector = null, $compare = null)
     {
@@ -1572,7 +1575,7 @@ 
      * @param      $url
      * @param null $data
      * @param null $callback
-     * @return PhpQuery|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
+     * @return PhpQueryObject
      * @todo Support $selector
      */
     public function load($url, $data = null, $callback = null)
@@ -1639,7 +1642,7 @@ 
      * Either sets the CSS property of an object or retrieves the
      * CSS property of a proejct.
      *
-     * @param      $property_name
+     * @param      string $property_name
      * @param bool $value
      * @return string of css property value
      * @todo
@@ -1810,7 +1813,7 @@ 
     /**
      * Trigger a type of event on every matched element.
      *
-     * @param                 $type
+     * @param                 string $type
      * @param array|\PhpQuery $data
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      * @TODO support more than event in $type (space-separated)
@@ -1839,7 +1842,7 @@ 
      * Binds a handler to one or more events (like click) for each matched element.
      * Can also bind custom events.
      *
-     * @param       $type
+     * @param       string $type
      * @param mixed $data Optional
      * @param       $callback
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
@@ -1863,7 +1866,7 @@ 
      *
      * @param string $type
      * @param        $callback
-     * @return unknown
+     * @return PhpQueryObject
      * @TODO namespace events
      * @TODO support more than event in $type (space-separated)
      */
@@ -2097,7 +2100,7 @@ 
     /**
      * Enter description here...
      *
-     * @param $num
+     * @param integer $num
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
     public function eq($num)
@@ -2113,7 +2116,7 @@ 
     /**
      * Enter description here...
      *
-     * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
+     * @return integer
      */
     public function size()
     {
@@ -2123,7 +2126,7 @@ 
     /**
      * Enter description here...
      *
-     * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
+     * @return integer
      * @deprecated Use length as attribute
      */
     public function length()
@@ -2186,7 +2189,7 @@ 
     /**
      * Enter description here...
      *
-     * @param String|PhpQuery $content
+     * @param string $content
      * @link http://docs.jquery.com/Manipulation/replaceWith#content
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
@@ -2261,7 +2264,7 @@ 
     /**
      * jQuey difference
      *
-     * @param      $markup
+     * @param      string $markup
      * @param null $callback1
      * @param null $callback2
      * @param null $callback3
@@ -2639,7 +2642,7 @@ 
      * Internal insert method. Don't use it.
      *
      * @param unknown_type $target
-     * @param unknown_type $type
+     * @param string $type
      * @throws \Exception
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      * @access private
@@ -2825,7 +2828,7 @@ 
     /**
      * Enter description here...
      *
-     * @param unknown_type $start
+     * @param integer $start
      * @param unknown_type $end
      *
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
@@ -3034,6 +3037,7 @@ 
 
     /**
      * @access private
+     * @param string $direction
      */
     protected function getElementSiblings($direction, $selector = null, $limitToOne = false)
     {
@@ -3062,7 +3066,7 @@ 
     /**
      * Enter description here...
      *
-     * @param null $selector
+     * @param string $selector
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
     public function siblings($selector = null)
@@ -3082,7 +3086,7 @@ 
     /**
      * Enter description here...
      *
-     * @param null $selector
+     * @param string $selector
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
     public function not($selector = null)
@@ -3312,6 +3316,9 @@ 
         }
     }
 
+    /**
+     * @param string $attr
+     */
     public function attr($attr = null, $value = null)
     {
         foreach ($this->stack(1) as $node) {
@@ -3405,7 +3412,7 @@ 
     /**
      * Enter description here...
      *
-     * @param $attr
+     * @param string $attr
      * @return PhpQueryObject|QueryTemplatesSource|QueryTemplatesParse|QueryTemplatesSourceQuery
      */
     public function removeAttr($attr)
@@ -3721,8 +3728,8 @@ 
     /**
      * Enter description here...
      *
-     * @param <type> $key
-     * @param <type> $value
+     * @param string $key
+     * @param string $value
      * @return $this
      */
     public function data($key, $value = null)
@@ -3859,7 +3866,7 @@ 
      * Returns node's XPath.
      *
      * @param unknown_type $oneNode
-     * @param null         $namespace
+     * @param string         $namespace
      * @return string
      * @TODO   use native getNodePath is avaible
      * @access private
@@ -3898,6 +3905,10 @@ 
     }
 
     // HELPERS
+
+    /**
+     * @return integer
+     */
     public function whois($oneNode = null)
     {
         $return = array();

src/Plugin/Scripts.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
      * @param $name
      * @param $callback
      * @throws \Exception
-     * @return bool
+     * @return boolean|null
      */
 	public static function script($name, $callback) {
 		if (\PhpQuery\Plugin\UtilScripts::$scriptMethods[$name])

src/Tests/BasicTest.php

Doc Comments -1 removed lines

@@ -187,7 +187,6 @@
   }
 
   /**
-   * @param PhpQueryObject $pq
    * @dataProvider provider
    * @return void
    */