Automattic / jetpack

_inc/lib/class.color.php

Doc Comments +14 added lines, -2 removed lines

@@ -149,6 +149,9 @@ 
 
 	/**
 	 * Helper function for Jetpack_Color::fromHsl()
+	 * @param double $p
+	 * @param double $q
+	 * @param integer $t
 	 */
 	private function hue2rgb( $p, $q, $t ) {
 		if ( $t < 0 ) $t += 1;
@@ -278,7 +281,7 @@ 
 	 * Get HSV values for color
 	 * (integer values from 0-255, fast but less accurate)
 	 *
-	 * @return int
+	 * @return string
 	 */
 	public function toHsvInt()
 	{
@@ -498,7 +501,7 @@ 
 	 *
 	 * @param Jetpack_Color $color
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getDistanceRgbFrom(Jetpack_Color $color)
 	{
@@ -682,6 +685,9 @@ 
 		return $this->incrementLightness( $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementLightness( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -699,6 +705,9 @@ 
 		return $this->incrementSaturation( - $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementSaturation( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -739,6 +748,9 @@ 
 		return $this->incrementHue( $incr );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementHue( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );

_inc/lib/markdown/extra.php

Doc Comments +26 added lines

@@ -156,6 +156,9 @@ 
 	}
 
 
+	/**
+	 * @param string $text
+	 */
 	function transform($text) {
 	#
 	# Main function. Performs some preprocessing on the input text
@@ -890,6 +893,10 @@ 
 
 	public $list_level = 0;
 
+	/**
+	 * @param string $list_str
+	 * @param string $marker_any_re
+	 */
 	function processListItems($list_str, $marker_any_re) {
 	#
 	#	Process the contents of a single ordered or unordered list, splitting it
@@ -993,6 +1000,9 @@ 
 	}
 
 
+	/**
+	 * @param string $code
+	 */
 	function makeCodeSpan($code) {
 	#
 	# Create a code span markup for $code. Called from handleSpanToken.
@@ -1485,6 +1495,9 @@ 
 	# hanlde UTF-8 if the default function does not exist.
 	public $utf8_strlen = 'mb_strlen';
 
+	/**
+	 * @param string $text
+	 */
 	function detab($text) {
 	#
 	# Replace tabs with the appropriate amount of space.
@@ -2029,6 +2042,12 @@ 
 
 		return array($parsed, $text);
 	}
+
+	/**
+	 * @param string $text
+	 * @param string $hash_method
+	 * @param boolean $md_attr
+	 */
 	function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr) {
 	#
 	# Parse HTML, calling _HashHTMLBlocks_InMarkdown for block tags.
@@ -2693,6 +2712,9 @@ 
 	}
 
 
+	/**
+	 * @return string
+	 */
 	function processDefListItems($list_str) {
 	#
 	#	Process the contents of a single definition list, splitting it
@@ -2804,6 +2826,10 @@ 
 
 		return $text;
 	}
+
+	/**
+	 * @param string[] $matches
+	 */
 	function _doFencedCodeBlocks_callback($matches) {
 		$classname =& $matches[2];
 		$attrs     =& $matches[3];

_inc/lib/tonesque.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 	 * Construct object from image.
 	 *
 	 * @param optional $type (hex, rgb, hsl)
-	 * @return color as a string formatted as $type
+	 * @return false|string as a string formatted as $type
 	 *
  	 */
 	function color( $type = 'hex' ) {

class.jetpack-client.php

Doc Comments +1 added lines

@@ -7,6 +7,7 @@
 	/**
 	 * Makes an authorized remote request using Jetpack_Signature
 	 *
+	 * @param string $body
 	 * @return array|WP_Error WP HTTP response on success
 	 */
 	public static function remote_request( $args, $body = null ) {

class.jetpack-data.php

Doc Comments +2 added lines, -1 removed lines

@@ -43,7 +43,7 @@ 
 	/**
 	 * This function mirrors Jetpack_Data::is_usable_domain() in the WPCOM codebase.
 	 *
-	 * @param $domain
+	 * @param string|false $domain
 	 * @param array $extra
 	 *
 	 * @return bool|WP_Error
@@ -104,6 +104,7 @@ 
 	 * See: https://bugs.php.net/bug.php?id=66229 and https://github.com/php/php-src/commit/d1314893fd1325ca6aa0831101896e31135a2658
 	 *
 	 * This function mirrors Jetpack_Data::php_bug_66229_check() in the WPCOM codebase.
+	 * @param string $ip
 	 */
 	public static function php_bug_66229_check( $ip ) {
 		if ( ! filter_var( $ip, FILTER_VALIDATE_IP ) ) {

class.jetpack-signature.php

Doc Comments +3 added lines

@@ -183,6 +183,9 @@
 	}
 }
 
+/**
+ * @param string $text
+ */
 function jetpack_sha1_base64( $text ) {
 	return base64_encode( sha1( $text, true ) );
 }

json-endpoints/class.wpcom-json-api-list-posts-v1-1-endpoint.php

Doc Comments +3 added lines

@@ -328,6 +328,9 @@
 		return build_query( array( 'value' => urlencode($post[$column]), 'id' => $post['ID'] ) );
 	}
 
+	/**
+	 * @param string $column
+	 */
 	function _build_date_range_query( $column, $range, $where ) {
 		global $wpdb;
 

json-endpoints/class.wpcom-json-api-menus-v1-1-endpoint.php

Doc Comments +3 added lines

@@ -297,6 +297,7 @@ 
 	 * @param array $items item tree
 	 * @param array &$items_list output flat list of items
 	 * @param int &$counter for creating temporary IDs
+	 * @param integer $counter
 	 */
 	protected function untreeify_items( $items, &$items_list, &$counter ) {
 		foreach( $items as $index => $item ) {
@@ -546,6 +547,7 @@ 
 	 * This function will create items that have a 'tmp_id' set, and
 	 * update any items with a 'tmp_parent' to use the
 	 * newly created item as a parent.
+	 * @param integer $menu_id
 	 */
 	function create_new_items( $data, $menu_id ) {
 		$tmp_to_actual_ids = array();
@@ -571,6 +573,7 @@ 
 	/**
 	 * remove any existing menu items not present in the supplied array.
 	 * returns wp_error if an item cannot be deleted.
+	 * @param integer $menu_id
 	 */
 	function delete_items_not_present( $menu_id, $menu_items ) {
 

json-endpoints/class.wpcom-json-api-update-comment-endpoint.php

Doc Comments +16 added lines

@@ -35,6 +35,12 @@ 
 
 	// /sites/%s/posts/%d/replies/new    -> $blog_id, $post_id
 	// /sites/%s/comments/%d/replies/new -> $blog_id, $comment_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 * @param integer $comment_parent_id
+	 */
 	function new_comment( $path, $blog_id, $post_id, $comment_parent_id ) {
 		if ( !$post_id ) {
 			$comment_parent = get_comment( $comment_parent_id );
@@ -146,6 +152,11 @@ 
 	}
 
 	// /sites/%s/comments/%d -> $blog_id, $comment_id
+
+	/**
+	 * @param string $path
+	 * @param integer $comment_id
+	 */
 	function update_comment( $path, $blog_id, $comment_id ) {
 		$comment = get_comment( $comment_id );
 		if ( !$comment || is_wp_error( $comment ) ) {
@@ -235,6 +246,11 @@ 
 	}
 
 	// /sites/%s/comments/%d/delete -> $blog_id, $comment_id
+
+	/**
+	 * @param string $path
+	 * @param integer $comment_id
+	 */
 	function delete_comment( $path, $blog_id, $comment_id ) {
 		$comment = get_comment( $comment_id );
 		if ( !$comment || is_wp_error( $comment ) ) {