Automattic / jetpack

packages/tracking/legacy/class-jetpack-tracks-client.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * Record an event.
 	 *
-	 * @param  mixed $event Event object to send to Tracks. An array will be cast to object. Required.
+	 * @param  Jetpack_Tracks_Event $event Event object to send to Tracks. An array will be cast to object. Required.
 	 *                      Properties are included directly in the pixel query string after light validation.
 	 * @return mixed         True on success, WP_Error on failure
 	 */

modules/shortcodes/vimeo.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
  * @param array $attr     The attributes of the shortcode.
  * @param array $old_attr Optional array of attributes from the old shortcode format.
  *
- * @return array Width and height.
+ * @return integer[] Width and height.
  */
 function jetpack_shortcode_get_vimeo_dimensions( $attr, $old_attr = array() ) {
 	global $content_width;

modules/shortcodes/youtube.php

Doc Comments +1 added lines, -1 removed lines

@@ -382,7 +382,7 @@
  *
  * @param array $query_args The query args of the URL.
  *
- * @return array The width and height of the shortcode.
+ * @return integer[] The width and height of the shortcode.
  */
 function jetpack_shortcode_youtube_dimensions( $query_args ) {
 	global $content_width;

packages/sync/src/class-listener.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,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 ) {

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

packages/connection/src/class-manager.php

Doc Comments +4 added lines, -3 removed lines

@@ -273,7 +273,7 @@ 
 	/**
 	 * Verifies the signature of the current request.
 	 *
-	 * @return false|array
+	 * @return boolean
 	 */
 	public function verify_xml_rpc_signature() {
 		if ( is_null( $this->xmlrpc_verification ) ) {
@@ -637,7 +637,7 @@ 
 	 * @param Integer $user_id (optional) the user identifier, defaults to current user.
 	 * @param String  $redirect_url the URL to redirect the user to for processing, defaults to
 	 *                              admin_url().
-	 * @return WP_Error only in case of a failed user lookup.
+	 * @return \WP_Error|null only in case of a failed user lookup.
 	 */
 	public function connect_user( $user_id = null, $redirect_url = null ) {
 		$user = null;
@@ -1167,6 +1167,7 @@ 
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
+	 * @return string
 	 */
 	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		if ( false === $user_id ) {
@@ -1660,7 +1661,7 @@ 
 	 *
 	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
 	 * @param string|false $token_key If provided, check that the token matches the provided input.
-	 * @param bool|true    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
+	 * @param boolean    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
 	 *
 	 * @return object|false
 	 */

modules/shortcodes/class.filter-embedded-html-objects.php

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
 	/**
 	 * Filter and replace HTML element.
 	 *
-	 * @param array  $matches Array of matches.
+	 * @param string[]  $matches Array of matches.
 	 * @param string $orig_html Original html. Returned if no results are found via $matches processing.
 	 */
 	private static function dispatch( $matches, $orig_html = null ) {

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

Doc Comments +4 added lines, -4 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;
@@ -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 ) );
@@ -266,7 +266,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.
 	 *

class.jetpack.php

Doc Comments +32 added lines, -18 removed lines

@@ -807,7 +807,7 @@ 
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
 	 *
 	 * @param $domains
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_wpcom_domain( $domains ) {
 		if ( empty( $domains ) ) {
@@ -1222,7 +1222,7 @@ 
 	/**
 	 * Does the network allow admins to add new users.
 	 *
-	 * @return boolian
+	 * @return boolean
 	 */
 	static function network_add_new_users( $option = null ) {
 		return (bool) get_site_option( 'add_new_users' );
@@ -1332,7 +1332,7 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1343,7 +1343,7 @@ 
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
 	 *
 	 * @param  string $option
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_multisite( $option ) {
 		return (string) (bool) is_multisite();
@@ -1406,7 +1406,7 @@ 
 	/**
 	 * Returns true if the site has file write access false otherwise.
 	 *
-	 * @return string ( '1' | '0' )
+	 * @return integer ( '1' | '0' )
 	 **/
 	public static function file_system_write_access() {
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -2142,7 +2142,7 @@ 
 	 * @param int    $user_id The user id.
 	 * @param string $token The user token.
 	 * @param bool   $is_master_user Whether the user is the master user.
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
@@ -2585,7 +2585,7 @@ 
 	 *
 	 * @param string $tag Tag as it appears in each module heading.
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function translate_module_tag( $tag ) {
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2757,8 +2757,8 @@ 
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
 	 *
-	 * @param $string
-	 * @return mixed
+	 * @param string $string
+	 * @return string|null
 	 */
 	public static function alias_directories( $string ) {
 		// ABSPATH has a trailing slash.
@@ -2769,6 +2769,10 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3052,6 +3056,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = self::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3080,6 +3087,10 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3829,7 +3840,7 @@ 
 	 * Add help to the Jetpack page
 	 *
 	 * @since Jetpack (1.2.3)
-	 * @return false if not the Jetpack page
+	 * @return false|null if not the Jetpack page
 	 */
 	function admin_help() {
 		$current_screen = get_current_screen();
@@ -5126,7 +5137,7 @@ 
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
-	 * @return array
+	 * @return boolean
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		return self::connection()->generate_secrets( $action, $user_id, $exp );
@@ -5433,7 +5444,6 @@ 
 	/**
 	 * Report authentication status to the WP REST API.
 	 *
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
 	 */
 	public function wp_rest_authentication_errors( $value ) {
@@ -5535,6 +5545,7 @@ 
 	 * @param string $key
 	 * @param string $value
 	 * @param bool   $restate private
+	 * @return string
 	 */
 	public static function state( $key = null, $value = null, $restate = false ) {
 		static $state = array();
@@ -5593,6 +5604,9 @@ 
 		self::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5673,6 +5687,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6242,9 +6259,7 @@ 
 	 *
 	 * Attached to `style_loader_src` filter.
 	 *
-	 * @param string $tag The tag that would link to the external asset.
 	 * @param string $handle The registered handle of the script in question.
-	 * @param string $href The url of the asset in question.
 	 */
 	public static function set_suffix_on_min( $src, $handle ) {
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6435,8 +6450,8 @@ 
 	 *  - Absolute URLs             `http://domain.com/feh.png`
 	 *  - Domain root relative URLs `/feh.png`
 	 *
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
 	 *
 	 * @return mixed|string
 	 */
@@ -6697,7 +6712,7 @@ 
 	/**
 	 * Stores and prints out domains to prefetch for page speed optimization.
 	 *
-	 * @param mixed $new_urls
+	 * @param string[] $new_urls
 	 */
 	public static function dns_prefetch( $new_urls = null ) {
 		static $prefetch_urls = array();
@@ -6754,7 +6769,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {