Automattic / jetpack

packages/sync/src/class-replicastore.php

Doc Comments +1 added lines, -1 removed lines

@@ -295,7 +295,7 @@
 	 * @access private
 	 *
 	 * @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.
 	 */
 	private function comment_status_to_approval_value( $status ) {
 		switch ( $status ) {

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;

packages/sync/src/interface-replicastore.php

Doc Comments +34 added lines

@@ -20,6 +20,7 @@ 
 	 * Empty and reset the replicastore.
 	 *
 	 * @access public
+	 * @return void
 	 */
 	public function reset();
 
@@ -29,6 +30,7 @@ 
 	 * @access public
 	 *
 	 * @param array $config Full sync configuration for this sync module.
+	 * @return void
 	 */
 	public function full_sync_start( $config );
 
@@ -38,6 +40,7 @@ 
 	 * @access public
 	 *
 	 * @param string $checksum Deprecated since 7.3.0.
+	 * @return void
 	 */
 	public function full_sync_end( $checksum );
 
@@ -51,6 +54,7 @@ 
 	 * @param string $status Post status.
 	 * @param int    $min_id Minimum post ID.
 	 * @param int    $max_id Maximum post ID.
+	 * @return integer
 	 */
 	public function post_count( $status = null, $min_id = null, $max_id = null );
 
@@ -81,6 +85,7 @@ 
 	 *
 	 * @param \WP_Post $post   Post object.
 	 * @param bool     $silent Whether to perform a silent action.
+	 * @return void
 	 */
 	public function upsert_post( $post, $silent = false );
 
@@ -90,6 +95,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function delete_post( $post_id );
 
@@ -121,6 +127,7 @@ 
 	 * @param string $status Comment status.
 	 * @param int    $min_id Minimum comment ID.
 	 * @param int    $max_id Maximum comment ID.
+	 * @return integer
 	 */
 	public function comment_count( $status = null, $min_id = null, $max_id = null );
 
@@ -150,6 +157,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_Comment $comment Comment object.
+	 * @return void
 	 */
 	public function upsert_comment( $comment );
 
@@ -159,6 +167,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function trash_comment( $comment_id );
 
@@ -168,6 +177,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function spam_comment( $comment_id );
 
@@ -177,6 +187,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function delete_comment( $comment_id );
 
@@ -187,6 +198,7 @@ 
 	 *
 	 * @param int   $post_id  Post ID.
 	 * @param array $statuses Post statuses.
+	 * @return void
 	 */
 	public function trashed_post_comments( $post_id, $statuses );
 
@@ -196,6 +208,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function untrashed_post_comments( $post_id );
 
@@ -226,6 +239,7 @@ 
 	 *
 	 * @param string $option Option name.
 	 * @param mixed  $value  Option value.
+	 * @return boolean
 	 */
 	public function update_option( $option, $value );
 
@@ -245,6 +259,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean
 	 */
 	public function delete_option( $option );
 
@@ -254,6 +269,7 @@ 
 	 * @access public
 	 *
 	 * @param array $theme_support Features that the theme supports.
+	 * @return void
 	 */
 	public function set_theme_support( $theme_support );
 
@@ -288,6 +304,7 @@ 
 	 * @param string $meta_key   Meta key.
 	 * @param mixed  $meta_value Meta value.
 	 * @param int    $meta_id    ID of the meta.
+	 * @return boolean
 	 */
 	public function upsert_metadata( $type, $object_id, $meta_key, $meta_value, $meta_id );
 
@@ -299,6 +316,7 @@ 
 	 * @param string $type      Meta type.
 	 * @param int    $object_id ID of the object.
 	 * @param array  $meta_ids  IDs of the meta objects to delete.
+	 * @return false|null
 	 */
 	public function delete_metadata( $type, $object_id, $meta_ids );
 
@@ -310,6 +328,7 @@ 
 	 * @param string $type       Meta type.
 	 * @param array  $object_ids IDs of the objects.
 	 * @param string $meta_key   Meta key.
+	 * @return false|null
 	 */
 	public function delete_batch_metadata( $type, $object_ids, $meta_key );
 
@@ -329,6 +348,7 @@ 
 	 *
 	 * @param string $constant Name of constant to retrieve.
 	 * @param mixed  $value    Value set for the constant.
+	 * @return void
 	 */
 	public function set_constant( $constant, $value );
 
@@ -339,6 +359,7 @@ 
 	 * @access public
 	 *
 	 * @param string $type Type of updates to retrieve.
+	 * @return integer|null
 	 */
 	public function get_updates( $type );
 
@@ -350,6 +371,7 @@ 
 	 *
 	 * @param string $type    Type of updates to set.
 	 * @param int    $updates Total number of updates.
+	 * @return void
 	 */
 	public function set_updates( $type, $updates );
 
@@ -369,6 +391,7 @@ 
 	 *
 	 * @param string $callable Callable name.
 	 * @param mixed  $value    Callable value.
+	 * @return void
 	 */
 	public function set_callable( $callable, $value );
 
@@ -388,6 +411,7 @@ 
 	 *
 	 * @param string $option Network option name.
 	 * @param mixed  $value  Network option value.
+	 * @return boolean
 	 */
 	public function update_site_option( $option, $value );
 
@@ -397,6 +421,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean
 	 */
 	public function delete_site_option( $option );
 
@@ -458,6 +483,7 @@ 
 	 * @param string           $taxonomy  The context in which to relate the term to the object.
 	 * @param string|int|array $terms     A single term slug, single term id, or array of either term slugs or ids.
 	 * @param bool             $append    Optional. If false will delete difference of terms. Default false.
+	 * @return void
 	 */
 	public function update_object_terms( $object_id, $taxonomy, $terms, $append );
 
@@ -470,6 +496,7 @@ 
 	 *
 	 * @param int   $object_id ID of the object.
 	 * @param array $tt_ids    Term taxonomy IDs.
+	 * @return boolean
 	 */
 	public function delete_object_terms( $object_id, $tt_ids );
 
@@ -477,6 +504,7 @@ 
 	 * Retrieve the number of users.
 	 *
 	 * @access public
+	 * @return void
 	 */
 	public function user_count();
 
@@ -495,6 +523,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_User $user User object.
+	 * @return void
 	 */
 	public function upsert_user( $user );
 
@@ -504,6 +533,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user( $user_id );
 
@@ -514,6 +544,7 @@ 
 	 *
 	 * @param int    $user_id User ID.
 	 * @param string $locale  The user locale.
+	 * @return void
 	 */
 	public function upsert_user_locale( $user_id, $locale );
 
@@ -523,6 +554,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user_locale( $user_id );
 
@@ -532,6 +564,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return string
 	 */
 	public function get_user_locale( $user_id );
 
@@ -541,6 +574,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function get_allowed_mime_types( $user_id );
 

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

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

Doc Comments +1 added lines, -1 removed lines

@@ -539,7 +539,7 @@
 	 * @access private
 	 *
 	 * @param string $name    Name of the option.
-	 * @param mixed  $default Default value of the option.
+	 * @param integer  $default Default value of the option.
 	 * @return mixed Option value.
 	 */
 	private function get_status_option( $name, $default = null ) {

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

packages/sync/src/modules/class-term-relationships.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,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_term_relationships' );

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

Doc Comments +2 added lines, -2 removed lines

@@ -502,7 +502,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;
@@ -522,7 +522,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_theme_data' );

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

Doc Comments +3 added lines, -3 removed lines

@@ -183,7 +183,7 @@ 
 	 *
 	 * @access public
 	 *
-	 * @param \WP_User $user User object.
+	 * @param \WP_User|null $user User object.
 	 * @return \WP_User Expanded user object.
 	 */
 	public function expand_user( $user ) {
@@ -614,7 +614,7 @@ 
 	 * @todo Refactor to prepare the SQL query before executing it.
 	 *
 	 * @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;
@@ -658,7 +658,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_users' );