Automattic / jetpack

json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

Doc Comments +3 added lines

@@ -228,6 +228,9 @@
 		);
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	protected function get_buffer( $queue, $number_of_items ) {
 		$start = time();
 		$max_duration = 5; // this will try to get the buffer

packages/sync/src/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/src/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/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/Module.php

Doc Comments +16 added lines

@@ -42,6 +42,9 @@ 
 		return array();
 	}
 
+	/**
+	 * @param string[] $actions_to_count
+	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
 	}
@@ -58,6 +61,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $action_name
+	 * @param string $id_field
+	 */
 	protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) {
 		global $wpdb;
 
@@ -111,6 +118,9 @@ 
 		return $chunks_with_ends;
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	protected function get_metadata( $ids, $meta_type, $meta_key_whitelist ) {
 		global $wpdb;
 		$table = _get_meta_table( $meta_type );
@@ -131,12 +141,18 @@ 
 		);
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	public function init_listeners_for_meta_type( $meta_type, $callable ) {
 		add_action( "added_{$meta_type}_meta", $callable, 10, 4 );
 		add_action( "updated_{$meta_type}_meta", $callable, 10, 4 );
 		add_action( "deleted_{$meta_type}_meta", $callable, 10, 4 );
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	public function init_meta_whitelist_handler( $meta_type, $whitelist_handler ) {
 		add_filter( "jetpack_sync_before_enqueue_added_{$meta_type}_meta", $whitelist_handler );
 		add_filter( "jetpack_sync_before_enqueue_updated_{$meta_type}_meta", $whitelist_handler );

packages/sync/src/Module_Callables.php

Doc Comments +3 added lines

@@ -171,6 +171,9 @@
 		update_option( 'jetpack_plugin_api_action_links', $plugins_action_links );
 	}
 
+	/**
+	 * @param integer $checksum
+	 */
 	public function should_send_callable( $callable_checksums, $name, $checksum ) {
 		$idc_override_callables = array(
 			'main_network_site',

packages/sync/src/Module_Full_Sync.php

Doc Comments +6 added lines

@@ -194,6 +194,9 @@ 
 		do_action( 'jetpack_full_sync_end', '', $range );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function get_range( $type ) {
 		global $wpdb;
 		if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) {
@@ -404,6 +407,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/src/Module_Users.php

Doc Comments +3 added lines

@@ -94,6 +94,9 @@
 		return $user;
 	}
 
+	/**
+	 * @param WP_User|null $user
+	 */
 	public function expand_user( $user ) {
 		if ( ! is_object( $user ) ) {
 			return null;

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;