Automattic / jetpack

projects/packages/options/legacy/class-jetpack-options.php

Doc Comments +3 added lines, -3 removed lines

@@ -27,7 +27,7 @@ 
 	 *
 	 * @param string $type The type of option to return. Defaults to 'compact'.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_option_names( $type = 'compact' ) {
 		switch ( $type ) {
@@ -505,7 +505,7 @@ 
 	 * @since 5.4.0
 	 *
 	 * @param boolean $strip_unsafe_options If true, and by default, will strip out options necessary for the connection to WordPress.com.
-	 * @return array An array of all options managed via the Jetpack_Options class.
+	 * @return string[] An array of all options managed via the Jetpack_Options class.
 	 */
 	public static function get_all_jetpack_options( $strip_unsafe_options = true ) {
 		$jetpack_options            = self::get_option_names();
@@ -548,7 +548,7 @@ 
 	 *
 	 * @since 5.4.0
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_all_wp_options() {
 		// A manual build of the wp options.

projects/packages/sync/src/modules/class-posts.php

Doc Comments +2 added lines, -2 removed lines

@@ -201,7 +201,7 @@ 
 	 * @todo Use $wpdb->prepare for the SQL query.
 	 *
 	 * @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;
@@ -237,7 +237,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_posts' );

projects/packages/sync/src/replicastore/class-table-checksum.php

Doc Comments +2 added lines, -2 removed lines

@@ -224,7 +224,7 @@ 
 	 *
 	 * @param string $table Table name to validate.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 * @throws Exception Throw an exception on validation failure.
 	 */
 	private function validate_table_name( $table ) {
@@ -482,7 +482,7 @@ 
 	 * @param int|null $range_to   The end of the range.
 	 * @param int|null $limit      How many values to return.
 	 *
-	 * @return array|object|void
+	 * @return boolean
 	 * @throws Exception Throws an exception if validation fails on the internal function calls.
 	 */
 	public function get_range_edges( $range_from = null, $range_to = null, $limit = null ) {

projects/plugins/jetpack/_inc/class.jetpack-provision.php

Doc Comments +3 added lines

@@ -249,6 +249,9 @@
 		}
 	}
 
+	/**
+	 * @param string $access_token
+	 */
 	private static function verify_token( $access_token ) {
 		$request = array(
 			'headers' => array(

projects/plugins/jetpack/_inc/lib/class.core-rest-api-endpoints.php

Doc Comments -1 removed lines

@@ -1264,7 +1264,6 @@
 	 *
 	 * @since 4.3.0
 	 *
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
 	 *
 	 * @return object
 	 */

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/json-endpoints/class.wpcom-json-api-update-post-endpoint.php

Doc Comments +19 added lines

@@ -28,6 +28,11 @@ 
 
 	// /sites/%s/posts/new       -> $blog_id
 	// /sites/%s/posts/%d        -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function write_post( $path, $blog_id, $post_id ) {
 		$new  = $this->api->ends_with( $path, '/new' );
 		$args = $this->query_args();
@@ -610,6 +615,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/delete -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function delete_post( $path, $blog_id, $post_id ) {
 		$post = get_post( $post_id );
 		if ( !$post || is_wp_error( $post ) ) {
@@ -645,6 +655,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/restore -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function restore_post( $path, $blog_id, $post_id ) {
 		$args  = $this->query_args();
 		$post = get_post( $post_id );
@@ -665,6 +680,10 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 * @param string $featured_image
+	 */
 	private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

projects/plugins/jetpack/json-endpoints/class.wpcom-json-api-update-post-v1-1-endpoint.php

Doc Comments +17 added lines

@@ -214,6 +214,11 @@ 
 
 	// /sites/%s/posts/new       -> $blog_id
 	// /sites/%s/posts/%d        -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function write_post( $path, $blog_id, $post_id ) {
 		global $wpdb;
 
@@ -890,6 +895,10 @@ 
 	}
 
 	// /sites/%s/posts/%d/delete -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 */
 	function delete_post( $path, $blog_id, $post_id ) {
 		$post = get_post( $post_id );
 		if ( !$post || is_wp_error( $post ) ) {
@@ -929,6 +938,10 @@ 
 	}
 
 	// /sites/%s/posts/%d/restore -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 */
 	function restore_post( $path, $blog_id, $post_id ) {
 		$args  = $this->query_args();
 		$post = get_post( $post_id );
@@ -949,6 +962,10 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 * @param string $featured_image
+	 */
 	protected function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

projects/plugins/jetpack/json-endpoints/jetpack/class.jetpack-json-api-plugins-endpoint.php

Doc Comments +3 added lines

@@ -170,6 +170,9 @@
 	}
 
 
+	/**
+	 * @param string $plugin
+	 */
 	protected function validate_plugin( $plugin ) {
 		if ( ! isset( $plugin) || empty( $plugin ) ) {
 			return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );