Automattic / jetpack

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

Doc Comments +5 added lines, -5 removed lines

@@ -66,7 +66,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;
@@ -142,7 +142,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).
@@ -181,8 +181,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 ) );
@@ -288,7 +288,7 @@ 
 	 * @param string $id_field Name of the ID field in the database.
 	 * @param string $where_sql The SQL WHERE clause to filter to the desired items.
 	 * @param float  $send_until timestamp until we want this request to send full sync events.
-	 * @param array  $status the current module full sync status.
+	 * @param boolean  $status the current module full sync status.
 	 *
 	 * @return array Status, the module full sync status updated.
 	 */