Automattic / jetpack

projects/plugins/jetpack/class.jetpack-gutenberg.php

Doc Comments +4 added lines, -4 removed lines

@@ -583,7 +583,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
@@ -837,7 +837,7 @@ 
 	 *
 	 * @param string $slug  Block slug.
 	 * @param array  $attr  Block attributes.
-	 * @param array  $extra Potential extra classes you may want to provide.
+	 * @param string[]  $extra Potential extra classes you may want to provide.
 	 *
 	 * @return string $classes List of CSS classes for a block.
 	 */
@@ -934,10 +934,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 (

projects/plugins/jetpack/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 );

projects/plugins/jetpack/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 ) {

projects/plugins/jetpack/class.photon.php

Doc Comments +2 added lines, -2 removed lines

@@ -42,7 +42,7 @@ 
 	/**
 	 * Singleton implementation
 	 *
-	 * @return object
+	 * @return Jetpack_Photon|null
 	 */
 	public static function instance() {
 		if ( ! is_a( self::$instance, 'Jetpack_Photon' ) ) {
@@ -1382,7 +1382,7 @@ 
 	 * after ourselves without breaking anyone else's filters.
 	 *
 	 * @internal
-	 * @return true
+	 * @return boolean
 	 */
 	public function override_image_downsize_in_rest_edit_context() {
 		return true;

projects/plugins/jetpack/extensions/blocks/podcast-player/podcast-player.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
  * @param string $name           Template name, available in `./templates` folder.
  * @param array  $template_props Template properties. Optional.
  * @param bool   $print          Render template. True as default.
- * @return false|string          HTML markup or false.
+ * @return string|null          HTML markup or false.
  */
 function render( $name, $template_props = array(), $print = true ) {
 	if ( ! strpos( $name, '.php' ) ) {

projects/plugins/jetpack/functions.photon.php

Doc Comments +1 added lines, -1 removed lines

@@ -326,7 +326,7 @@
  *
  * @param string  $url The URL to parse.
  * @param integer $component Retrieve specific URL component.
- * @return mixed Result of parse_url
+ * @return string|false Result of parse_url
  */
 function jetpack_photon_parse_url( $url, $component = -1 ) {
 	_deprecated_function( 'jetpack_photon_parse_url', 'jetpack-7.8.0', 'wp_parse_url' );

projects/plugins/jetpack/json-endpoints/class.wpcom-json-api-edit-media-v1-2-endpoint.php

Doc Comments +3 added lines, -3 removed lines

@@ -101,7 +101,7 @@ 
 	 * Update the media post grabbing the post values from
 	 * the `attrs` parameter
 	 *
-	 * @param  {Number} $media_id - post media ID
+	 * @param  integer $media_id - post media ID
 	 * @param  {Object} $attrs - `attrs` parameter sent from the client in the request body
 	 * @return
 	 */
@@ -202,7 +202,7 @@ 
 	 * Save the given temporal file in a local folder.
 	 *
 	 * @param  {Array} $file_array
-	 * @param  {Number} $media_id
+	 * @param  integer $media_id
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */
 	private function save_temporary_file( $file_array, $media_id ) {
@@ -277,7 +277,7 @@ 
 	/**
 	 * Get the image from a remote url and then save it locally.
 	 *
-	 * @param  {Number} $media_id - media post ID
+	 * @param  integer $media_id - media post ID
 	 * @param  {String} $url - image URL to save locally
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */

projects/plugins/jetpack/json-endpoints/class.wpcom-json-api-list-post-type-taxonomies-endpoint.php

Doc Comments +3 added lines

@@ -75,6 +75,9 @@
 		);
 	}
 
+	/**
+	 * @param string $post_type
+	 */
 	protected function localize_initial_taxonomies( $post_type ) {
 		/** This filter is documented in jetpack/json-endpoints/class.wpcom-json-api-list-post-types-endpoint.php */
 		if ( ! apply_filters( 'rest_api_localize_response', false ) ) {

projects/plugins/jetpack/json-endpoints/class.wpcom-json-api-list-posts-v1-1-endpoint.php

Doc Comments +3 added lines

@@ -433,6 +433,9 @@
 		);
 	}
 
+	/**
+	 * @param string $column
+	 */
 	function _build_date_range_query( $column, $range, $where ) {
 		global $wpdb;