Automattic / jetpack

packages/sync/src/modules/Users.php

Doc Comments +3 added lines, -3 removed lines

@@ -183,7 +183,7 @@ 
 	 *
 	 * @access public
 	 *
-	 * @param \WP_User $user User object.
+	 * @param \WP_User|null $user User object.
 	 * @return \WP_User Expanded user object.
 	 */
 	public function expand_user( $user ) {
@@ -614,7 +614,7 @@ 
 	 * @todo Refactor to prepare the SQL query before executing it.
 	 *
 	 * @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 ) {
 		global $wpdb;
@@ -658,7 +658,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_users' );

packages/sync/src/modules/WooCommerce.php

Doc Comments +2 added lines, -2 removed lines

@@ -150,7 +150,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_woocommerce_order_items' );
@@ -246,7 +246,7 @@ 
 	 * @todo Refactor the SQL query to use $wpdb->prepare().
 	 *
 	 * @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 ) {
 		global $wpdb;

packages/sync/src/Actions.php

Doc Comments +20 added lines

@@ -134,6 +134,9 @@ 
 		return ( Settings::get_setting( 'sync_via_cron' ) );
 	}
 
+	/**
+	 * @param boolean $should_publicize
+	 */
 	static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
 		if ( in_array( $post->post_type, Settings::get_setting( 'post_types_blacklist' ) ) ) {
 			return false;
@@ -146,6 +149,13 @@ 
 		Settings::set_importing( true );
 	}
 
+	/**
+	 * @param string $codec_name
+	 * @param integer $sent_timestamp
+	 * @param integer $queue_id
+	 * @param integer $checkout_duration
+	 * @param integer $preprocess_duration
+	 */
 	static function send_data( $data, $codec_name, $sent_timestamp, $queue_id, $checkout_duration, $preprocess_duration ) {
 		\Jetpack::load_xml_rpc_client();
 
@@ -350,6 +360,9 @@ 
 		return $sync_modules;
 	}
 
+	/**
+	 * @return string
+	 */
 	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
 		$schedule  = sanitize_key( $schedule );
 		$schedules = wp_get_schedules();
@@ -387,6 +400,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $hook
+	 */
 	static function maybe_schedule_sync_cron( $schedule, $hook ) {
 		if ( ! $hook ) {
 			return;
@@ -436,6 +452,10 @@ 
 		self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
 	}
 
+	/**
+	 * @param string $new_version
+	 * @param string $old_version
+	 */
 	static function cleanup_on_upgrade( $new_version = null, $old_version = null ) {
 		if ( wp_next_scheduled( 'jetpack_sync_send_db_checksum' ) ) {
 			wp_clear_scheduled_hook( 'jetpack_sync_send_db_checksum' );