Automattic / jetpack

packages/sync/src/Listener.php

Doc Comments +3 added lines

@@ -177,6 +177,9 @@
 		$queue->add_all( $data_to_enqueue );
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	function enqueue_action( $current_filter, $args, $queue ) {
 		// don't enqueue an action during the outbound http request - this prevents recursion
 		if ( Settings::is_sending() ) {

packages/sync/src/Queue.php

Doc Comments +6 added lines

@@ -240,6 +240,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param Queue_Buffer $buffer
+	 */
 	function close( $buffer, $ids_to_remove = null ) {
 		$is_valid = $this->validate_checkout( $buffer );
 
@@ -344,6 +347,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		global $wpdb;
 

packages/sync/src/Sender.php

Doc Comments +10 added lines

@@ -70,6 +70,9 @@ 
 		return (float) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
 	}
 
+	/**
+	 * @param integer $time
+	 */
 	public function set_next_sync_time( $time, $queue_name ) {
 		return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true );
 	}
@@ -100,6 +103,9 @@ 
 		return $this->do_sync_and_set_delays( $this->sync_queue );
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	public function do_sync_and_set_delays( $queue ) {
 		// don't sync if importing
 		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -357,6 +363,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}

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

Doc Comments +10 added lines, -4 removed lines

@@ -16,7 +16,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 ) {
@@ -199,6 +199,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function update_grouped_option( $group, $name, $value ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( ! is_array( $options ) ) {
@@ -301,6 +304,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function get_grouped_option( $group, $name, $default ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
@@ -420,7 +426,7 @@ 
 	 * This function checks for a constant that, if present, will disable direct DB queries Jetpack uses to manage certain options and force Jetpack to always use Options API instead.
 	 * Options can be selectively managed via a blacklist by filtering option names via the jetpack_disabled_raw_option filter.
 	 *
-	 * @param $name Option name
+	 * @param string $name Option name
 	 *
 	 * @return bool
 	 */
@@ -445,7 +451,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.
 	 */
 	static function get_all_jetpack_options( $strip_unsafe_options = true ) {
 		$jetpack_options            = self::get_option_names();
@@ -488,7 +494,7 @@ 
 	 *
 	 * @since 5.4.0
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	static function get_all_wp_options() {
 		// A manual build of the wp options

tools/import-translations.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 /**
  * Converts GlotPress URL into a GlotPress API URL
  *
- * @param sring $url URL
+ * @param string $url URL
  * @return sstring API URL
  */
 function apize_url( $url ) {

packages/tracking/legacy/class.tracks-client.php

Doc Comments +2 added lines, -1 removed lines

@@ -48,7 +48,7 @@ 
 
 	/**
 	 * record_event
-	 * @param  mixed  $event Event object to send to Tracks. An array will be cast to object. Required.
+	 * @param  Jetpack_Tracks_Event  $event Event object to send to Tracks. An array will be cast to object. Required.
 	 *                       Properties are included directly in the pixel query string after light validation.
 	 * @return mixed         True on success, WP_Error on failure
 	 */
@@ -71,6 +71,7 @@ 
 
 	/**
 	 * Synchronously request the pixel
+	 * @param string $pixel
 	 */
 	static function record_pixel( $pixel ) {
 		// Add the Request Timestamp and URL terminator just before the HTTP request.

_inc/lib/plugins.php

Doc Comments +3 added lines

@@ -95,6 +95,9 @@
 		return (array) $upgrader->skin->get_upgrade_messages();
 	}
 
+	 /**
+	  * @param string $plugin_slug
+	  */
 	 protected static function generate_wordpress_org_plugin_download_link( $plugin_slug ) {
 		return "https://downloads.wordpress.org/plugin/$plugin_slug.latest-stable.zip";
 	 }

packages/connection/src/Manager.php

Doc Comments +2 added lines, -2 removed lines

@@ -106,7 +106,7 @@ 
 	 * Is the user the connection owner.
 	 *
 	 * @param Integer $user_id the user identifier.
-	 * @return Boolean is the user the connection owner?
+	 * @return integer is the user the connection owner?
 	 */
 	public function is_connection_owner( $user_id ) {
 		return $user_id;
@@ -570,7 +570,7 @@ 
 	 *
 	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
 	 * @param string|false $token_key If provided, check that the token matches the provided input.
-	 * @param bool|true    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
+	 * @param boolean    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
 	 *
 	 * @return object|false
 	 */

packages/connection/tests/php/test_Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -115,7 +115,7 @@
 	 * Mock a global function and make it return a certain value.
 	 *
 	 * @param string $function_name Name of the function.
-	 * @param mixed  $return_value  Return value of the function.
+	 * @param integer  $return_value  Return value of the function.
 	 * @return phpmock\Mock The mock object.
 	 */
 	protected function mock_function( $function_name, $return_value = null ) {