Automattic / jetpack

modules/shortcodes/class.filter-embedded-html-objects.php

Doc Comments +1 added lines, -1 removed lines

@@ -221,7 +221,7 @@
 	/**
 	 * Filter and replace HTML element.
 	 *
-	 * @param array $matches Array of matches.
+	 * @param string[] $matches Array of matches.
 	 */
 	private static function dispatch( $matches ) {
 		$html  = preg_replace( '%&#0*58;//%', '://', $matches[0] );

sync/class.jetpack-sync-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 );

_inc/lib/class.media-summary.php

Doc Comments +6 added lines

@@ -271,6 +271,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	static function get_video_poster( $type, $id ) {
 		if ( 'videopress' == $type ) {
 			if ( function_exists( 'video_get_highest_resolution_image_url' ) ) {
@@ -356,6 +359,9 @@ 
 		return (int) count( self::split_content_in_words( self::clean_text( $post_content ) ) );
 	}
 
+	/**
+	 * @param string $excerpt_content
+	 */
 	static function get_word_remaining_count( $post_content, $excerpt_content ) {
 		$content_word_count = count( self::split_content_in_words( self::clean_text( $post_content ) ) );
 		$excerpt_word_count = count( self::split_content_in_words( self::clean_text( $excerpt_content ) ) ); 

sync/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 );
 

_inc/lib/debugger/class-jetpack-cxn-test-base.php

Doc Comments +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
 	 * @param string $type  Test type, async or direct. Optional, direct all tests.
 	 * @param string $group Testing group to check status of. Optional, default all tests.
 	 *
-	 * @return true|array True if all tests pass. Array of failed tests.
+	 * @return boolean True if all tests pass. Array of failed tests.
 	 */
 	public function pass( $type = 'all', $group = 'all' ) {
 		$results = $this->raw_results( $type, $group );

class.jetpack-gutenberg.php

Doc Comments +1 added lines, -1 removed lines

@@ -416,7 +416,7 @@
 	 * Only enqueue block assets when needed.
 	 *
 	 * @param string $type Slug of the block.
-	 * @param array  $script_dependencies Script dependencies. Will be merged with automatically
+	 * @param string[]  $script_dependencies Script dependencies. Will be merged with automatically
 	 *                                    detected script dependencies from the webpack build.
 	 *
 	 * @return void

modules/carousel/jetpack-carousel.php

Doc Comments +12 added lines

@@ -129,6 +129,9 @@ 
 		return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false );
 	}
 
+	/**
+	 * @param string $version
+	 */
 	function asset_version( $version ) {
 		/**
 		 * Filter the version string used when enqueuing Carousel assets.
@@ -511,6 +514,9 @@ 
 		return $attr;
 	}
 
+	/**
+	 * @param string $html
+	 */
 	function add_data_to_container( $html ) {
 		global $post;
 		if (
@@ -757,6 +763,9 @@ 
 		return ( 1 == $value ) ? 1 : 0;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) {
 		if ( empty( $name ) ) {
 			return;
@@ -772,6 +781,9 @@ 
 		echo '</fieldset>';
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_select( $name, $values, $extra_text = '' ) {
 		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
 			return;

sync/class.jetpack-sync-wp-replicastore.php

Doc Comments +10 added lines

@@ -447,6 +447,10 @@ 
 	}
 
 	// functions
+
+	/**
+	 * @param string $name
+	 */
 	public function get_callable( $name ) {
 		$value = get_option( 'jetpack_' . $name );
 
@@ -738,6 +742,9 @@ 
 		return $histogram;
 	}
 
+	/**
+	 * @param string|null $id_column
+	 */
 	private function table_checksum( $table, $columns, $id_column, $where_sql = '1=1', $min_id = null, $max_id = null, $strip_non_ascii = true, $salt = '' ) {
 		global $wpdb;
 
@@ -791,6 +798,9 @@ 
 		return 'sum';
 	}
 
+	/**
+	 * @param string $where_sql
+	 */
 	private function meta_count( $table, $where_sql, $min_id, $max_id ) {
 		global $wpdb;
 

modules/shortcodes/soundcloud.php

Doc Comments +2 added lines, -2 removed lines

@@ -142,7 +142,7 @@ 
 /**
  * Plugin options getter
  *
- * @param  string|array $option  Option name.
+ * @param  string $option  Option name.
  * @param  mixed        $default Default value.
  *
  * @return mixed                   Option value
@@ -158,7 +158,7 @@ 
  *
  * @param string $url Soundcloud URL.
  *
- * @return boolean
+ * @return integer
  */
 function soundcloud_url_has_tracklist( $url ) {
 	return preg_match( '/^(.+?)\/(sets|groups|playlists)\/(.+?)$/', $url );