Automattic / jetpack

projects/plugins/jetpack/_inc/lib/class.jetpack-password-checker.php

Doc Comments +1 added lines, -1 removed lines

@@ -410,7 +410,7 @@
 	 *
 	 * @param Mixed $needle the needle.
 	 * @param array $haystack the haystack.
-	 * @return is the needle not in the haystack?
+	 * @return boolean the needle not in the haystack?
 	 */
 	protected function negative_in_array( $needle, $haystack ) {
 		if ( in_array( $needle, $haystack, true ) ) {

projects/plugins/jetpack/_inc/lib/class.jetpack-search-performance-logger.php

Doc Comments +4 added lines

@@ -62,6 +62,10 @@
 		return $query->is_main_query() && $query->is_search();
 	}
 
+	/**
+	 * @param double $duration
+	 * @param boolean $was_jetpack_search
+	 */
 	private function record_query_time( $duration, $was_jetpack_search ) {
 		$this->stats[] = array( $was_jetpack_search, (int) ( $duration * 1000 ) );
 	}

projects/plugins/jetpack/_inc/lib/class.media.php

Doc Comments +7 added lines, -3 removed lines

@@ -84,7 +84,7 @@ 
 	/**
 	 * Return an array of allowed mime_type items used to upload a media file.
 	 *
-	 * @return array mime_type array
+	 * @return string[] mime_type array
 	 */
 	static function get_allowed_mime_types( $default_mime_types ) {
 		return array_unique( array_merge( $default_mime_types, array(
@@ -252,7 +252,7 @@ 
 	 * @param  object $media_item - media post object
 	 * @param  file $file - file recently added
 	 * @param  bool $has_original_media - condition is the original media has been already added
-	 * @return bool `true` if the item has been added. Otherwise `false`.
+	 * @return false|null `true` if the item has been added. Otherwise `false`.
 	 */
 	public static function register_revision( $media_item, $file, $has_original_media ) {
 		if ( is_wp_error( $file ) || ! $has_original_media ) {
@@ -280,6 +280,9 @@ 
 		return $original;
 	}
 
+	/**
+	 * @param string $pathname
+	 */
 	public static function delete_file( $pathname ) {
 		if ( ! file_exists( $pathname ) || ! is_file( $pathname ) ) {
 			// let's touch a fake file to try to `really` remove the media file
@@ -295,7 +298,7 @@ 
 	 *
 	 * @param  number $media_id - media post ID
 	 * @param  string $filename - basename of the file ( name-of-file.ext )
-	 * @return bool `true` is the file has been removed, `false` if not.
+	 * @return boolean|null `true` is the file has been removed, `false` if not.
 	 */
 	private static function delete_media_history_file( $media_id, $filename ) {
 		$attached_path = get_attached_file( $media_id );
@@ -365,6 +368,7 @@ 
 	 *
 	 * @param  number $media_id - media post ID
 	 * @param  number [$limit] - maximun amount of items. 20 as default.
+	 * @param integer $limit
 	 * @return array items removed from `revision_history`
 	 */
 	public static function limit_revision_history( $media_id, $limit = null) {

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

Doc Comments +30 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|null
 	 */
 	public function update_option( $option, $value );
 
@@ -245,6 +259,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean|null
 	 */
 	public function delete_option( $option );
 
@@ -254,6 +269,7 @@ 
 	 * @access public
 	 *
 	 * @param array $theme_info Theme info array.
+	 * @return void
 	 */
 	public function set_theme_info( $theme_info );
 
@@ -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|null
 	 */
 	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 );
 
@@ -350,6 +369,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 +389,7 @@ 
 	 *
 	 * @param string $callable Callable name.
 	 * @param mixed  $value    Callable value.
+	 * @return void
 	 */
 	public function set_callable( $callable, $value );
 
@@ -388,6 +409,7 @@ 
 	 *
 	 * @param string $option Network option name.
 	 * @param mixed  $value  Network option value.
+	 * @return boolean|null
 	 */
 	public function update_site_option( $option, $value );
 
@@ -397,6 +419,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean|null
 	 */
 	public function delete_site_option( $option );
 
@@ -458,6 +481,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 +494,7 @@ 
 	 *
 	 * @param int   $object_id ID of the object.
 	 * @param array $tt_ids    Term taxonomy IDs.
+	 * @return boolean|null
 	 */
 	public function delete_object_terms( $object_id, $tt_ids );
 
@@ -477,6 +502,7 @@ 
 	 * Retrieve the number of users.
 	 *
 	 * @access public
+	 * @return null|integer
 	 */
 	public function user_count();
 
@@ -495,6 +521,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_User $user User object.
+	 * @return void
 	 */
 	public function upsert_user( $user );
 
@@ -504,6 +531,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user( $user_id );
 
@@ -514,6 +542,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 +552,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user_locale( $user_id );
 

projects/packages/sync/src/modules/class-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;
@@ -124,7 +124,7 @@ 
 	 *
 	 * @access public
 	 *
-	 * @param array   $config               Full sync configuration for this sync module.
+	 * @param boolean   $config               Full sync configuration for this sync module.
 	 * @param int     $max_items_to_enqueue Maximum number of items to enqueue.
 	 * @param boolean $state                True if full sync has finished enqueueing this module, false otherwise.
 	 * @return array  Number of actions enqueued, and next module state.
@@ -166,8 +166,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 ) );
@@ -285,7 +285,7 @@ 
 	/**
 	 * Given the Module Full Sync Configuration and Status return the next chunk of items to send.
 	 *
-	 * @param array $config This module Full Sync configuration.
+	 * @param string $config This module Full Sync configuration.
 	 * @param array $status This module Full Sync status.
 	 * @param int   $chunk_size Chunk size.
 	 *

projects/plugins/jetpack/_inc/lib/core-api/class-wpcom-rest-field-controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,9 +109,9 @@
 	 *
 	 * This cannot be extended: implement `->get()` instead.
 	 *
-	 * @param mixed           $object_data Probably an array. Whatever the endpoint returns.
+	 * @param integer           $object_data Probably an array. Whatever the endpoint returns.
 	 * @param string          $field_name Should always match `->field_name`
-	 * @param WP_REST_Request $request
+	 * @param integer $request
 	 * @param string          $object_type Should always match `->object_type`
 	 * @return mixed
 	 */

projects/packages/autoloader/src/class-php-autoloader.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
 	 *
 	 * @param string $class_name The name of the class to autoload.
 	 *
-	 * @return bool Indicates whether or not a class file was loaded.
+	 * @return null|boolean Indicates whether or not a class file was loaded.
 	 */
 	public static function load_class( $class_name ) {
 		global $jetpack_autoloader_loader;

projects/packages/analyzer/src/class-declarations.php

Doc Comments +4 added lines

@@ -22,6 +22,7 @@ 
 
 	/**
 	 * Scan every PHP in the root
+	 * @param string $root
 	 */
 	public function scan( $root, $exclude = array() ) {
 		if ( is_dir( $root ) ) {
@@ -33,6 +34,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	public function scan_dir( $root, $exclude = array() ) {
 
 		if ( is_null( $exclude ) || ! is_array( $exclude ) ) {

projects/packages/connection/src/class-nonce-handler.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
 	 * @param int $cutoff_timestamp All nonces added before this timestamp will be removed.
 	 * @param int $time_limit How long the cleanup can run (in seconds).
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function clean_all( $cutoff_timestamp = PHP_INT_MAX, $time_limit = 20 ) {
 		// phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed