Automattic / jetpack

packages/sync/src/modules/WooCommerce.php

Doc Comments +3 added lines, -3 removed lines

@@ -154,7 +154,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_woocommerce_order_items' );
@@ -251,7 +251,7 @@ 
 	 * @param int     $send_until Maximum duration of processing.
 	 * @param boolean $state True if full sync has finished enqueueing this module, false otherwise.
 	 *
-	 * @return array Number of actions enqueued, and next module state.
+	 * @return boolean Number of actions enqueued, and next module state.
 	 */
 	public function send_full_sync_actions( $config, $send_until, $state ) {
 		return $this->send_all_ids_as_action( 'jetpack_full_sync_woocommerce_order_items', $this->order_item_table_name, 'order_item_id', $this->get_where_sql( $config ), $send_until, $state );
@@ -265,7 +265,7 @@ 
 	 * @todo Refactor the SQL query to use $wpdb->prepare().
 	 *
 	 * @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;

packages/sync/src/modules/Module.php

Doc Comments +5 added lines, -5 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;
@@ -143,7 +143,7 @@ 
 	 * @param float   $send_until timestamp until we want this request to send full sync events.
 	 * @param boolean $state True if full sync has finished enqueueing this module, false otherwise.
 	 *
-	 * @return array  Number of actions sent, and next module state.
+	 * @return integer[]  Number of actions sent, and next module state.
 	 */
 	public function send_full_sync_actions( $config, $send_until, $state ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		// In subclasses, return the number of actions sent, and next module state (true == done).
@@ -182,8 +182,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 ) );
@@ -291,7 +291,7 @@ 
 	 * @param float   $send_until timestamp until we want this request to send full sync events.
 	 * @param boolean $status the current module full sync status.
 	 *
-	 * @return array Status, the module full sync status updated.
+	 * @return boolean Status, the module full sync status updated.
 	 */
 	protected function send_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $send_until, $status ) {
 		global $wpdb;