Automattic / jetpack

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

modules/infinite-scroll/infinity.php

Doc Comments +1 added lines, -1 removed lines

@@ -1283,7 +1283,7 @@
 	 * Returns an array of stock and custom taxonomy query vars
 	 *
 	 * @global $wp_taxonomies
-	 * @return array
+	 * @return string[]
 	 */
 	function get_taxonomy_vars() {
 		global $wp_taxonomies;

sal/class.json-api-site-base.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 	public $blog_id;
 	public $platform;
 
+	/**
+	 * @param WPORG_Platform $platform
+	 */
 	public function __construct( $blog_id, $platform ) {
 		$this->blog_id = $blog_id;
 		$this->platform = $platform;

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/simple-payments/simple-payments.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 	 * Allows custom post types to be used by REST API.
 	 * @param $post_types
 	 * @see hook 'rest_api_allowed_post_types'
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_rest_api_types( $post_types ) {
 		$post_types[] = self::$post_type_order;

modules/carousel/jetpack-carousel.php

Doc Comments +12 added lines

@@ -129,6 +129,9 @@ 
 		return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false );
 	}
 
+	/**
+	 * @param string $version
+	 */
 	function asset_version( $version ) {
 		/**
 		 * Filter the version string used when enqueuing Carousel assets.
@@ -511,6 +514,9 @@ 
 		return $attr;
 	}
 
+	/**
+	 * @param string $html
+	 */
 	function add_data_to_container( $html ) {
 		global $post;
 		if (
@@ -757,6 +763,9 @@ 
 		return ( 1 == $value ) ? 1 : 0;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) {
 		if ( empty( $name ) ) {
 			return;
@@ -772,6 +781,9 @@ 
 		echo '</fieldset>';
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_select( $name, $values, $extra_text = '' ) {
 		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
 			return;

sal/class.json-api-links.php

Doc Comments +2 added lines, -1 removed lines

@@ -30,6 +30,7 @@ 
 	 * Used to construct meta links in API responses
 	 *
 	 * @param mixed ...$args Optional arguments to be appended to URL
+	 * @param string $args
 	 * @return string Endpoint URL
 	 **/
 	function get_link( ...$args ) {
@@ -128,7 +129,7 @@ 
 	 * This method is used in get_link() to construct meta links for API responses.
 	 *
 	 * @param $template_path string The generic endpoint path, e.g. /sites/%s
-	 * @param $path string The current endpoint path, relative to the version, e.g. /sites/12345
+	 * @param string $path string The current endpoint path, relative to the version, e.g. /sites/12345
 	 * @param $request_method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */

packages/sync/src/class-actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -336,7 +336,7 @@ 
 	 * @access public
 	 * @static
 	 *
-	 * @return bool|null False if sync is not allowed.
+	 * @return false|null False if sync is not allowed.
 	 */
 	public static function do_initial_sync() {
 		// Lets not sync if we are not suppose to.
@@ -506,7 +506,7 @@ 
 	 * @static
 	 *
 	 * @param array $sync_modules The list of sync modules declared prior to this filter.
-	 * @return array A list of sync modules that now includes Woo's modules.
+	 * @return string[] A list of sync modules that now includes Woo's modules.
 	 */
 	public static function add_woocommerce_sync_module( $sync_modules ) {
 		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WooCommerce';
@@ -533,7 +533,7 @@ 
 	 * @static
 	 *
 	 * @param array $sync_modules The list of sync modules declared prior to this filer.
-	 * @return array A list of sync modules that now includes WP Super Cache's modules.
+	 * @return string[] A list of sync modules that now includes WP Super Cache's modules.
 	 */
 	public static function add_wp_super_cache_sync_module( $sync_modules ) {
 		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WP_Super_Cache';

packages/sync/src/modules/class-comments.php

Doc Comments +1 added lines, -1 removed lines

@@ -220,7 +220,7 @@
 	 *
 	 * @access public
 	 *
-	 * @return array Full sync actions of this module.
+	 * @return string[] Full sync actions of this module.
 	 */
 	public function get_full_sync_actions() {
 		return array( 'jetpack_full_sync_comments' );