Automattic / jetpack

_inc/lib/class.color.php

Doc Comments +13 added lines, -1 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;
@@ -498,7 +501,7 @@ 
 	 *
 	 * @param Jetpack_Color $color
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getDistanceRgbFrom(Jetpack_Color $color)
 	{
@@ -687,6 +690,9 @@ 
 		return $this->incrementLightness( $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementLightness( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -704,6 +710,9 @@ 
 		return $this->incrementSaturation( - $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementSaturation( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -744,6 +753,9 @@ 
 		return $this->incrementHue( $incr );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementHue( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );

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/connection/legacy/class-jetpack-signature.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
 	 * @param string $url              Request URL.
 	 * @param mixed  $body             Request body.
 	 * @param bool   $verify_body_hash Whether to verify the body hash against the body.
-	 * @return string|WP_Error Request signature, or a WP_Error on failure.
+	 * @return string Request signature, or a WP_Error on failure.
 	 */
 	public function sign_request( $token = '', $timestamp = 0, $nonce = '', $body_hash = '', $method = '', $url = '', $body = null, $verify_body_hash = true ) {
 		if ( ! $this->secret ) {

packages/options/legacy/class-jetpack-options.php

Doc Comments +3 added lines, -3 removed lines

@@ -27,7 +27,7 @@ 
 	 *
 	 * @param string $type The type of option to return. Defaults to 'compact'.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_option_names( $type = 'compact' ) {
 		switch ( $type ) {
@@ -505,7 +505,7 @@ 
 	 * @since 5.4.0
 	 *
 	 * @param boolean $strip_unsafe_options If true, and by default, will strip out options necessary for the connection to WordPress.com.
-	 * @return array An array of all options managed via the Jetpack_Options class.
+	 * @return string[] An array of all options managed via the Jetpack_Options class.
 	 */
 	public static function get_all_jetpack_options( $strip_unsafe_options = true ) {
 		$jetpack_options            = self::get_option_names();
@@ -548,7 +548,7 @@ 
 	 *
 	 * @since 5.4.0
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_all_wp_options() {
 		// A manual build of the wp options.

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/class-json-deflate-array-codec.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 	/**
 	 * Wraps JSON
 	 *
-	 * @param object|array $any Wrapping value.
+	 * @param string $any Wrapping value.
 	 * @param array        $seen_nodes Seen nodes.
 	 * @return array
 	 */

packages/sync/src/class-queue.php

Doc Comments +1 added lines, -1 removed lines

@@ -374,7 +374,7 @@
 	/**
 	 * Close the buffer.
 	 *
-	 * @param Automattic\Jetpack\Sync\Queue_Buffer $buffer Queue_Buffer object.
+	 * @param Queue_Buffer $buffer Queue_Buffer object.
 	 * @param null|array                           $ids_to_remove Ids to remove from the queue.
 	 *
 	 * @return bool|\WP_Error

packages/sync/src/class-server.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 	 *
 	 * @access public
 	 *
-	 * @param Automattic\Jetpack\Sync\Codec_Interface $codec Codec instance.
+	 * @param Codec_Interface $codec Codec instance.
 	 */
 	public function set_codec( Codec_Interface $codec ) {
 		$this->codec = $codec;

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

Doc Comments +2 added lines, -2 removed lines

@@ -222,7 +222,7 @@ 
 	 * @access public
 	 *
 	 * @param array $config Full sync configuration for this sync module.
-	 * @return array Number of items yet to be enqueued.
+	 * @return integer Number of items yet to be enqueued.
 	 */
 	public function estimate_full_sync_actions( $config ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		return 1;
@@ -233,7 +233,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_callables' );