Automattic / jetpack

_inc/lib/tracks/client.php

Doc Comments -1 removed lines

@@ -107,7 +107,6 @@
 /**
  * Record an event in Tracks - this is the preferred way to record events from PHP.
  *
- * @param mixed $identity username, user_id, or WP_user object
  * @param string $event_name The name of the event
  * @param array $properties Custom properties to send with the event
  * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred

modules/custom-css/custom-css.php

Doc Comments +1 added lines, -1 removed lines

@@ -1404,7 +1404,7 @@
 	/**
 	 * Migration routine for moving safecss from wp_options to wp_posts to support revisions
 	 *
-	 * @return void
+	 * @return false|null
 	 */
 	static function upgrade() {
 		$css = get_option( 'safecss' );

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

Doc Comments +72 added lines

@@ -273,6 +273,9 @@ 
 		}
 	}
 
+	/**
+	 * @param stdClass $block
+	 */
 	protected function flattenSelectors($block, $parentKey = null) {
 		if ($block->selectors) {
 			$selectors = array();
@@ -362,6 +365,10 @@ 
 	}
 
 	// TODO refactor compileNestedBlock and compileMedia into same thing
+
+	/**
+	 * @param string[] $selectors
+	 */
 	protected function compileNestedBlock($block, $selectors) {
 		$this->pushEnv($block);
 
@@ -1140,6 +1147,9 @@ 
 		return $this->toBool($left[1] < $right[1]);
 	}
 
+	/**
+	 * @param boolean $thing
+	 */
 	public function toBool($thing) {
 		return $thing ? self::$true : self::$false;
 	}
@@ -1268,6 +1278,10 @@ 
 	}
 
 	// find the final set of selectors
+
+	/**
+	 * @param stdClass $env
+	 */
 	protected function multiplySelectors($env) {
 		$envs = array();
 		while (null !== $env) {
@@ -1474,6 +1488,9 @@ 
 		$env->store[$name] = $value;
 	}
 
+	/**
+	 * @param boolean $defaultValue
+	 */
 	public function get($name, $defaultValue = null, $env = null) {
 		$name = $this->normalizeName($name);
 
@@ -1503,6 +1520,9 @@ 
 		$this->importPaths[] = $path;
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function setImportPaths($path) {
 		$this->importPaths = (array)$path;
 	}
@@ -1511,6 +1531,9 @@ 
 		$this->numberPrecision = $numberPrecision;
 	}
 
+	/**
+	 * @param string $formatterName
+	 */
 	public function setFormatter($formatterName) {
 		$this->formatter = $formatterName;
 	}
@@ -1544,6 +1567,10 @@ 
 	}
 
 	// results the file path for an import url if it exists
+
+	/**
+	 * @param string $url
+	 */
 	public function findImport($url) {
 		$urls = array();
 
@@ -1579,6 +1606,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function fileExists($name) {
 		return is_file($name);
 	}
@@ -1766,6 +1796,11 @@ 
 		return array('hsl', fmod($h, 360), $s * 100, $l * 100);
 	}
 
+	/**
+	 * @param double $m1
+	 * @param double $m2
+	 * @param double $h
+	 */
 	public function hueToRGB($m1, $m2, $h) {
 		if ($h < 0)
 			$h += 1;
@@ -1850,6 +1885,10 @@ 
 	}
 
 	// helper function for adjust_color, change_color, and scale_color
+
+	/**
+	 * @param string $fn
+	 */
 	protected function alter_color($args, $fn) {
 		$color = $this->assertColor($args[0]);
 
@@ -2047,6 +2086,9 @@ 
 		return array("number", $hsl[3], "%");
 	}
 
+	/**
+	 * @param integer $idx
+	 */
 	protected function adjustHsl($color, $idx, $amount) {
 		$hsl = $this->toHSL($color[1], $color[2], $color[3]);
 		$hsl[$idx] += $amount;
@@ -2965,6 +3007,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $what
+	 * @param boolean $eatWhitespace
+	 */
 	protected function literal($what, $eatWhitespace = null) {
 		if (is_null($eatWhitespace)) $eatWhitespace = $this->eatWhiteDefault;
 
@@ -2997,6 +3043,9 @@ 
 		return $b;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function pushSpecialBlock($type) {
 		$block = $this->pushBlock(null);
 		$block->type = $type;
@@ -3123,6 +3172,9 @@ 
 		return $this->genericList($out, "expression");
 	}
 
+	/**
+	 * @param string $parseItem
+	 */
 	protected function genericList(&$out, $parseItem, $delim="", $flatten=true) {
 		$s = $this->seek();
 		$items = array();
@@ -3171,6 +3223,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param integer $minP
+	 */
 	protected function expHelper($lhs, $minP) {
 		$opstr = self::$operatorStr;
 
@@ -3518,6 +3573,11 @@ 
 	}
 
 	// an unbounded string stopped by $end
+
+	/**
+	 * @param string $end
+	 * @param string $nestingOpen
+	 */
 	protected function openString($end, &$out, $nestingOpen=null) {
 		$oldWhite = $this->eatWhiteDefault;
 		$this->eatWhiteDefault = false;
@@ -3850,6 +3910,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param boolean $eatWhitespace
+	 */
 	protected function keyword(&$word, $eatWhitespace = null) {
 		if ($this->match('([\w_\-\*!"\'\\\\][\w\-_"\'\\\\]*)',
 			$m, $eatWhitespace))
@@ -3959,6 +4022,10 @@ 
 	}
 
 	// try to match something on head of buffer
+
+	/**
+	 * @param string $regex
+	 */
 	protected function match($regex, &$out, $eatWhitespace = null) {
 		if (is_null($eatWhitespace)) $eatWhitespace = $this->eatWhiteDefault;
 
@@ -3987,6 +4054,9 @@ 
 		return $gotWhite;
 	}
 
+	/**
+	 * @param string $regex
+	 */
 	protected function peek($regex, &$out, $from=null) {
 		if (is_null($from)) $from = $this->count;
 
@@ -4253,6 +4323,7 @@ 
 	/**
 	 * Get path to cached .css file
 	 *
+	 * @param string $fname
 	 * @return string
 	 */
 	protected function cacheName($fname) {
@@ -4262,6 +4333,7 @@ 
 	/**
 	 * Get path to cached imports
 	 *
+	 * @param string $out
 	 * @return string
 	 */
 	protected function importsCacheName($out) {

modules/theme-tools/content-options/blog-display.php

Doc Comments +1 added lines

@@ -138,6 +138,7 @@
 /**
  * Returns a class value, `output-the-content` by default.
  * Used for themes with a 'Mixed' Blog Display so we can tell which output is by default.
+ * @param string $new_class
  */
 function jetpack_the_content_customizer_class( $new_class = null ) {
 	static $class;

3rd-party/domain-mapping.php

Doc Comments +10 added lines

@@ -93,14 +93,24 @@
 	 * So that we can test.
 	 */
 
+	/**
+	 * @param string $class
+	 * @param string $method
+	 */
 	public function method_exists( $class, $method ) {
 		return method_exists( $class, $method );
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function class_exists( $class ) {
 		return class_exists( $class );
 	}
 
+	/**
+	 * @param string $function
+	 */
 	public function function_exists( $function ) {
 		return function_exists( $function );
 	}

class.jetpack-autoupdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 	/**
 	 * Iterates through expected items ( plugins or themes ) and compares them to actual results.
 	 *
-	 * @param $items 'plugin' or 'theme'
+	 * @param string $items 'plugin' or 'theme'
 	 */
 	private function log_items( $items ) {
 		if ( ! isset( $this->expected[ $items ] ) ) {

json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

Doc Comments +3 added lines

@@ -227,6 +227,9 @@
 		);
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	protected function get_buffer( $queue, $number_of_items ) {
 		$start = time();
 		$max_duration = 5; // this will try to get the buffer

modules/custom-post-types/portfolios.php

Doc Comments +5 added lines, -4 removed lines

@@ -488,7 +488,7 @@ 
 	 * Our [portfolio] shortcode.
 	 * Prints Portfolio data styled to look good on *any* theme.
 	 *
-	 * @return portfolio_shortcode_html
+	 * @return string
 	 */
 	static function portfolio_shortcode( $atts ) {
 		// Default attributes
@@ -621,7 +621,7 @@ 
 	 * The Portfolio shortcode loop.
 	 *
 	 * @todo add theme color styles
-	 * @return html
+	 * @return string
 	 */
 	static function portfolio_shortcode_html( $atts ) {
 
@@ -713,6 +713,7 @@ 
 	/**
 	 * Individual project class
 	 *
+	 * @param integer $portfolio_index_number
 	 * @return string
 	 */
 	static function get_project_class( $portfolio_index_number, $columns ) {
@@ -820,7 +821,7 @@ 
 	/**
 	 * Displays the author of the current portfolio project.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function get_project_author() {
 		$html = '<div class="project-author">';
@@ -837,7 +838,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_portfolio_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

modules/custom-post-types/testimonial.php

Doc Comments +4 added lines, -3 removed lines

@@ -525,7 +525,7 @@ 
 	 * Our [testimonial] shortcode.
 	 * Prints Testimonial data styled to look good on *any* theme.
 	 *
-	 * @return jetpack_testimonial_shortcode_html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode( $atts ) {
 		// Default attributes
@@ -588,7 +588,7 @@ 
 	/**
 	 * The Testimonial shortcode loop.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode_html( $atts ) {
 		// Default query arguments
@@ -662,6 +662,7 @@ 
 	/**
 	 * Individual testimonial class
 	 *
+	 * @param integer $testimonial_index_number
 	 * @return string
 	 */
 	static function get_testimonial_class( $testimonial_index_number, $columns, $image ) {
@@ -708,7 +709,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_testimonial_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {