Automattic / jetpack

modules/shortcodes/youtube.php

Doc Comments +1 added lines, -1 removed lines

@@ -382,7 +382,7 @@
  *
  * @param array $query_args The query args of the URL.
  *
- * @return array The width and height of the shortcode.
+ * @return integer[] The width and height of the shortcode.
  */
 function jetpack_shortcode_youtube_dimensions( $query_args ) {
 	global $content_width;

packages/sync/src/modules/class-constants.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 	 *
 	 * @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 ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		return 1;
@@ -169,7 +169,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_constants' );

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

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
 	/**
 	 * Filter and replace HTML element.
 	 *
-	 * @param array  $matches Array of matches.
+	 * @param string[]  $matches Array of matches.
 	 * @param string $orig_html Original html. Returned if no results are found via $matches processing.
 	 */
 	private static function dispatch( $matches, $orig_html = null ) {

packages/sync/src/modules/class-module.php

Doc Comments +4 added lines, -4 removed lines

@@ -67,7 +67,7 @@ 
 	 *
 	 * @param string $object_type Type of the sync object.
 	 * @param int    $id          ID of the sync object.
-	 * @return mixed Object, or false if the object is invalid.
+	 * @return boolean Object, or false if the object is invalid.
 	 */
 	public function get_object_by_id( $object_type, $id ) {
 		return false;
@@ -166,8 +166,8 @@ 
 	 * @access protected
 	 *
 	 * @param array $action_names     Action names we're interested in.
-	 * @param array $actions_to_count Unfiltered list of actions we want to count.
-	 * @return array Number of actions that we're interested in.
+	 * @param string[] $actions_to_count Unfiltered list of actions we want to count.
+	 * @return integer Number of actions that we're interested in.
 	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
@@ -266,7 +266,7 @@ 
 	/**
 	 * Given the Module Full Sync Configuration and Status return the next chunk of items to send.
 	 *
-	 * @param array $config This module Full Sync configuration.
+	 * @param string $config This module Full Sync configuration.
 	 * @param array $status This module Full Sync status.
 	 * @param int   $chunk_size Chunk size.
 	 *

packages/sync/src/class-functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -181,7 +181,7 @@ 
 	/**
 	 * Return a hosting provider using a set of known constants.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_constant() {
 		$hosting_provider_constants = array(
@@ -209,7 +209,7 @@ 
 	/**
 	 * Return a hosting provider using a set of known classes.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_class() {
 		$hosting_provider = false;
@@ -226,7 +226,7 @@ 
 	/**
 	 * Return a hosting provider using a set of known functions.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_function() {
 		$hosting_provider = false;
@@ -441,7 +441,7 @@ 
 	 *
 	 * @param string   $option Option value from the site.
 	 * @param callable $url_function Function retrieving the URL to normalize.
-	 * @return mixed|string URL.
+	 * @return callable URL.
 	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );

packages/sync/src/class-listener.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
 	 * Prevent adding items to the queue if it hasn't sent an item for 15 mins
 	 * AND the queue is over 1000 items long (by default).
 	 *
-	 * @param object $queue Sync queue.
+	 * @param string $queue Sync queue.
 	 * @return bool
 	 */
 	public function can_add_to_queue( $queue ) {
@@ -360,7 +360,7 @@ 
 	 * Sync Data Loss Handler
 	 *
 	 * @param Queue $queue Sync queue.
-	 * @return boolean was send successful
+	 * @return null|Items was send successful
 	 */
 	public function sync_data_loss( $queue ) {
 		if ( ! Settings::is_sync_enabled() ) {

class.json-api.php

Doc Comments +18 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
 	public $amp_source_origin = null;
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -348,6 +351,9 @@ 
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit       = $this->exit;
 		$this->exit = false;
@@ -572,11 +578,18 @@ 
 		return wp_json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
 
 	// Returns the site's blog_id in the WP.com ecosystem
+
+	/**
+	 * @return integer
+	 */
 	function get_blog_id_for_output() {
 		return $this->token_details['blog_id'];
 	}
@@ -599,6 +612,10 @@ 
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -648,7 +665,7 @@ 
 	/**
 	 * Counts the number of comments on a site, excluding certain comment types.
 	 *
-	 * @param $post_id int Post ID.
+	 * @param integer $post_id int Post ID.
 	 * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
 	 */
 	public function wp_count_comments( $post_id ) {

class.json-api-endpoints.php

Doc Comments +6 added lines, -1 removed lines

@@ -1540,6 +1540,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string $date_string Date to parse.
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1649,6 +1650,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {
@@ -2073,7 +2078,7 @@ 
 	 * Get an array of all valid AMP origins for a blog's siteurl.
 	 *
 	 * @param string $siteurl Origin url of the API request.
-	 * @return array
+	 * @return string[]
 	 */
 	public function get_amp_cache_origins( $siteurl ) {
 		$host = parse_url( $siteurl, PHP_URL_HOST );

class.jetpack-gutenberg.php

Doc Comments +3 added lines, -3 removed lines

@@ -518,7 +518,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
@@ -866,10 +866,10 @@ 
 	 * @since 8.3.0
 	 *
 	 * @param string $url      URL saved as an attribute in block.
-	 * @param array  $allowed  Array of allowed hosts for that block, or regexes to check against.
+	 * @param string[]  $allowed  Array of allowed hosts for that block, or regexes to check against.
 	 * @param bool   $is_regex Array of regexes matching the URL that could be used in block.
 	 *
-	 * @return bool|string
+	 * @return false|string
 	 */
 	public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
 		if (