Automattic / jetpack

packages/autoloader/src/AutoloadGenerator.php

Doc Comments +2 added lines, -2 removed lines

@@ -140,7 +140,7 @@ 
 	 * @param string     $vendorPath Path to the vendor directory.
 	 * @param string     $basePath Base Path.
 	 *
-	 * @return array $classMap
+	 * @return string $classMap
 	 */
 	private function getClassMap( array $autoloads, Filesystem $filesystem, $vendorPath, $basePath ) {
 		$blacklist      = null; // not supported for now.
@@ -178,7 +178,7 @@ 
 	/**
 	 * Generate the PHP that will be used in the autoload_classmap_package.php files.
 	 *
-	 * @param srting $classMap class map array string that is to be written out to the file.
+	 * @param string $classMap class map array string that is to be written out to the file.
 	 *
 	 * @return string
 	 */

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

packages/sync/legacy/class.jetpack-sync-actions.php

Doc Comments +6 added lines

@@ -321,6 +321,9 @@ 
 		return $sync_modules;
 	}
 
+	/**
+	 * @return string
+	 */
 	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
 		$schedule  = sanitize_key( $schedule );
 		$schedules = wp_get_schedules();
@@ -358,6 +361,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $hook
+	 */
 	static function maybe_schedule_sync_cron( $schedule, $hook ) {
 		if ( ! $hook ) {
 			return;

packages/sync/legacy/class.jetpack-sync-functions.php

Doc Comments +7 added lines

@@ -148,6 +148,7 @@ 
 	 * Helper function that is used when getting home or siteurl values. Decides
 	 * whether to get the raw or filtered value.
 	 *
+	 * @param string $url_type
 	 * @return string
 	 */
 	public static function get_raw_or_filtered_url( $url_type ) {
@@ -197,6 +198,9 @@ 
 		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
 	}
 
+	/**
+	 * @param string $callable
+	 */
 	public static function get_protocol_normalized_url( $callable, $new_value ) {
 		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
 
@@ -236,6 +240,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $url_function
+	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );
 		$option_url = wp_parse_url( get_option( $option ) );

packages/sync/legacy/class.jetpack-sync-listener.php

Doc Comments +3 added lines

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

packages/sync/legacy/class.jetpack-sync-module-full-sync.php

Doc Comments +6 added lines

@@ -185,6 +185,9 @@ 
 		do_action( 'jetpack_full_sync_end', '', $range );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function get_range( $type ) {
 		global $wpdb;
 		if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) {
@@ -323,6 +326,9 @@ 
 		$listener->get_full_sync_queue()->reset();
 	}
 
+	/**
+	 * @param integer $default
+	 */
 	private function get_status_option( $name, $default = null ) {
 		$value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );
 

packages/sync/legacy/class.jetpack-sync-queue.php

Doc Comments +6 added lines

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

packages/sync/legacy/class.jetpack-sync-sender.php

Doc Comments +10 added lines

@@ -76,6 +76,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 );
 	}
@@ -106,6 +109,9 @@ 
 		return $this->do_sync_and_set_delays( $this->sync_queue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	public function do_sync_and_set_delays( $queue ) {
 		// don't sync if importing
 		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -354,6 +360,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}

packages/sync/legacy/class.jetpack-sync-settings.php

Doc Comments +9 added lines

@@ -135,6 +135,9 @@ 
 		self::set_is_sending( null );
 	}
 
+	/**
+	 * @param boolean|null $is_importing
+	 */
 	static function set_importing( $is_importing ) {
 		// set to NULL to revert to WP_IMPORTING, the standard behavior
 		self::$is_importing = $is_importing;
@@ -165,6 +168,9 @@ 
 		return (bool) self::$is_syncing || ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST );
 	}
 
+	/**
+	 * @param boolean|null $is_syncing
+	 */
 	static function set_is_syncing( $is_syncing ) {
 		self::$is_syncing = $is_syncing;
 	}
@@ -173,6 +179,9 @@ 
 		return (bool) self::$is_sending;
 	}
 
+	/**
+	 * @param boolean|null $is_sending
+	 */
 	static function set_is_sending( $is_sending ) {
 		self::$is_sending = $is_sending;
 	}