Automattic / jetpack

projects/packages/sync/src/class-actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -336,7 +336,7 @@ 
 	 * @access public
 	 * @static
 	 *
-	 * @return bool|null False if sync is not allowed.
+	 * @return false|null False if sync is not allowed.
 	 */
 	public static function do_initial_sync() {
 		// Lets not sync if we are not suppose to.
@@ -506,7 +506,7 @@ 
 	 * @static
 	 *
 	 * @param array $sync_modules The list of sync modules declared prior to this filter.
-	 * @return array A list of sync modules that now includes Woo's modules.
+	 * @return string[] A list of sync modules that now includes Woo's modules.
 	 */
 	public static function add_woocommerce_sync_module( $sync_modules ) {
 		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WooCommerce';
@@ -533,7 +533,7 @@ 
 	 * @static
 	 *
 	 * @param array $sync_modules The list of sync modules declared prior to this filer.
-	 * @return array A list of sync modules that now includes WP Super Cache's modules.
+	 * @return string[] A list of sync modules that now includes WP Super Cache's modules.
 	 */
 	public static function add_wp_super_cache_sync_module( $sync_modules ) {
 		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WP_Super_Cache';

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

projects/packages/sync/src/class-json-deflate-array-codec.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 	/**
 	 * Wraps JSON
 	 *
-	 * @param object|array $any Wrapping value.
+	 * @param string $any Wrapping value.
 	 * @param array        $seen_nodes Seen nodes.
 	 * @return array
 	 */

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

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

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
 	 * @access protected
 	 *
 	 * @param string $status Comment status.
-	 * @return string|bool New comment_approved value, false if the status doesn't affect it.
+	 * @return string|false New comment_approved value, false if the status doesn't affect it.
 	 */
 	protected function comment_status_to_approval_value( $status ) {
 		switch ( (string) $status ) {

projects/packages/sync/src/class-server.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 	 *
 	 * @access public
 	 *
-	 * @param Automattic\Jetpack\Sync\Codec_Interface $codec Codec instance.
+	 * @param Codec_Interface $codec Codec instance.
 	 */
 	public function set_codec( Codec_Interface $codec ) {
 		$this->codec = $codec;

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

Doc Comments +2 added lines, -2 removed lines

@@ -222,7 +222,7 @@ 
 	 * @access public
 	 *
 	 * @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;
@@ -233,7 +233,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_callables' );

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

Doc Comments +1 added lines, -1 removed lines

@@ -220,7 +220,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_comments' );

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