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 );

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 ) ) {

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

Doc Comments +19 added lines

@@ -28,6 +28,11 @@ 
 
 	// /sites/%s/posts/new       -> $blog_id
 	// /sites/%s/posts/%d        -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function write_post( $path, $blog_id, $post_id ) {
 		$new  = $this->api->ends_with( $path, '/new' );
 		$args = $this->query_args();
@@ -610,6 +615,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/delete -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function delete_post( $path, $blog_id, $post_id ) {
 		$post = get_post( $post_id );
 		if ( !$post || is_wp_error( $post ) ) {
@@ -645,6 +655,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/restore -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function restore_post( $path, $blog_id, $post_id ) {
 		$args  = $this->query_args();
 		$post = get_post( $post_id );
@@ -665,6 +680,10 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 * @param string $featured_image
+	 */
 	private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

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

Doc Comments +17 added lines

@@ -26,6 +26,11 @@ 
 	}
 
 	// /sites/%s/tags|categories/new    -> $blog_id
+
+	/**
+	 * @param string $path
+	 * @param string $taxonomy_type
+	 */
 	function new_taxonomy( $path, $blog_id, $taxonomy_type ) {
 		$args  = $this->query_args();
 		$input = $this->input();
@@ -77,6 +82,12 @@ 
 	}
 
 	// /sites/%s/tags|categories/slug:%s -> $blog_id, $taxonomy_id
+
+	/**
+	 * @param string $path
+	 * @param integer $object_id
+	 * @param string $taxonomy_type
+	 */
 	function update_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) {
 		$taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type );
 		$tax      = get_taxonomy( $taxonomy_type );
@@ -122,6 +133,12 @@ 
 	}
 
 	// /sites/%s/tags|categories/%s/delete -> $blog_id, $taxonomy_id
+
+	/**
+	 * @param string $path
+	 * @param integer $object_id
+	 * @param string $taxonomy_type
+	 */
 	function delete_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) {
 		$taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type );
 		$tax      = get_taxonomy( $taxonomy_type );

modules/custom-css/csstidy/class.csstidy.php

Doc Comments +3 added lines, -2 removed lines

@@ -289,7 +289,7 @@ 
 	 * Get the value of a setting.
 	 * @param string $setting
 	 * @access public
-	 * @return mixed
+	 * @return string
 	 * @version 1.0
 	 */
 	function get_cfg($setting) {
@@ -358,7 +358,7 @@ 
 
 	/**
 	 * Adds a token to $this->tokens
-	 * @param mixed $type
+	 * @param integer $type
 	 * @param string $data
 	 * @param bool $do add a token even if preserve_css is off
 	 * @access private
@@ -1189,6 +1189,7 @@ 
 	 * format("abc, def, ghi") => format("abc, def, ghi")
 	 *
 	 * @param string
+	 * @param string $value
 	 * @return array
 	 */
 

modules/custom-css/csstidy/class.csstidy_ctype.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
 /* ctype_alpha  Check for alphabetic character(s) */
 if (!function_exists('ctype_alpha')) {
 
+	/**
+	 * @param string $text
+	 */
 	function ctype_alpha($text) {
 		return preg_match("/[a-zA-Z]/", $text);
 	}

modules/custom-css/custom-css/preprocessors/lessc.inc.php

Doc Comments +43 added lines

@@ -77,6 +77,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function fileExists($name) {
 		return is_file($name);
 	}
@@ -260,6 +263,9 @@ 
 		return $scope;
 	}
 
+	/**
+	 * @param string[] $selectors
+	 */
 	protected function compileNestedBlock($block, $selectors) {
 		$this->pushEnv($block);
 		$this->scope = $this->makeOutputBlock($block->type, $selectors);
@@ -278,6 +284,9 @@ 
 		$this->popEnv();
 	}
 
+	/**
+	 * @param stdClass $out
+	 */
 	protected function compileProps($block, $out) {
 		foreach ($this->sortProps($block->props) as $prop) {
 			$this->compileProp($prop, $block, $out);
@@ -388,6 +397,9 @@ 
 		return $out;
 	}
 
+	/**
+	 * @param stdClass $env
+	 */
 	protected function multiplyMedia($env, $childQueries = null) {
 		if (is_null($env) ||
 			!empty($env->block->type) && $env->block->type != "media")
@@ -1288,6 +1300,9 @@ 
 		$this->throwError($error);
 	}
 
+	/**
+	 * @param integer $expectedArgs
+	 */
 	public function assertArgs($value, $expectedArgs, $name="") {
 		if ($expectedArgs == 1) {
 			return $value;
@@ -1342,6 +1357,11 @@ 
 		return $out;
 	}
 
+	/**
+	 * @param double $comp
+	 * @param double $temp1
+	 * @param double $temp2
+	 */
 	protected function toRGB_helper($comp, $temp1, $temp2) {
 		if ($comp < 0) $comp += 1.0;
 		elseif ($comp > 1) $comp -= 1.0;
@@ -2317,6 +2337,9 @@ 
 	// caches preg escaped literals
 	static protected $literalCache = array();
 
+	/**
+	 * @param lessc $lessc
+	 */
 	public function __construct($lessc, $sourceName = null) {
 		$this->eatWhiteDefault = true;
 		// reference to less needed for vPrefix, mPrefix, and parentSelector
@@ -2617,6 +2640,7 @@ 
 
 	/**
 	 * recursively parse infix equation with $lhs at precedence $minP
+	 * @param integer $minP
 	 */
 	protected function expHelper($lhs, $minP) {
 		$this->inExp = true;
@@ -2843,6 +2867,11 @@ 
 	}
 
 	// an unbounded string stopped by $end
+
+	/**
+	 * @param string $end
+	 * @param string[] $rejectStrs
+	 */
 	protected function openString($end, &$out, $nestingOpen=null, $rejectStrs = null) {
 		$oldWhite = $this->eatWhiteDefault;
 		$this->eatWhiteDefault = false;
@@ -3423,6 +3452,9 @@ 
 
 	/* raw parsing functions */
 
+	/**
+	 * @param boolean $eatWhitespace
+	 */
 	protected function literal($what, $eatWhitespace = null) {
 		if ($eatWhitespace === null) $eatWhitespace = $this->eatWhiteDefault;
 
@@ -3446,6 +3478,9 @@ 
 		return $this->match(self::$literalCache[$what], $m, $eatWhitespace);
 	}
 
+	/**
+	 * @param string $parseItem
+	 */
 	protected function genericList(&$out, $parseItem, $delim="", $flatten=true) {
 		$s = $this->seek();
 		$items = array();
@@ -3519,6 +3554,10 @@ 
 	}
 
 	// match something without consuming it
+
+	/**
+	 * @param string $regex
+	 */
 	protected function peek($regex, &$out = null, $from=null) {
 		if (is_null($from)) $from = $this->count;
 		$r = '/'.$regex.'/Ais';
@@ -3574,6 +3613,10 @@ 
 	}
 
 	// push a block that doesn't multiply tags
+
+	/**
+	 * @param string $type
+	 */
 	protected function pushSpecialBlock($type) {
 		return $this->pushBlock(null, $type);
 	}