Automattic / jetpack

projects/plugins/jetpack/modules/stats.php

Doc Comments +4 added lines, -4 removed lines

@@ -290,7 +290,7 @@ 
  * Get Stats Options.
  *
  * @access public
- * @param mixed $option Option.
+ * @param string $option Option.
  * @return mixed|null.
  */
 function stats_get_option( $option ) {
@@ -744,7 +744,7 @@ 
  * Stats Convert Chart URLs.
  *
  * @access public
- * @param mixed $html HTML.
+ * @param string $html HTML.
  * @return string
  */
 function stats_convert_chart_urls( $html ) {
@@ -1414,7 +1414,7 @@ 
  *
  * @access public
  * @param mixed $get Get.
- * @param mixed $url URL.
+ * @param string $url URL.
  * @return void
  */
 function stats_print_wp_remote_error( $get, $url ) {
@@ -1556,7 +1556,7 @@ 
  * Stats get remote CSV.
  *
  * @access public
- * @param mixed $url URL.
+ * @param string $url URL.
  * @return array
  */
 function stats_get_remote_csv( $url ) {

projects/plugins/jetpack/modules/subscriptions/views.php

Doc Comments +1 added lines, -1 removed lines

@@ -557,7 +557,7 @@
 	/**
 	 * The default args for rendering a subscription form.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	static function defaults() {
 		$defaults = array(

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/class.jetpack.php

Doc Comments +36 added lines, -17 removed lines

@@ -956,7 +956,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 ) ) {
@@ -1324,7 +1324,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' );
@@ -1434,7 +1434,7 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1445,7 +1445,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();
@@ -1508,7 +1508,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' ) ) {
@@ -2237,7 +2237,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' );
@@ -2681,7 +2681,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 );
@@ -2796,8 +2796,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.
@@ -2808,6 +2808,10 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3091,6 +3095,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' );
@@ -3119,6 +3126,10 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3164,6 +3175,7 @@ 
 	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
 	 *
 	 * @static
+	 * @param boolean $network_wide
 	 */
 	public static function plugin_activation( $network_wide ) {
 		Jetpack_Options::update_option( 'activated', 1 );
@@ -3884,7 +3896,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();
@@ -4588,6 +4600,7 @@ 
 
 	/**
 	 * Record a stat for later output.  This will only currently output in the admin_footer.
+	 * @param string $group
 	 */
 	function stat( $group, $detail ) {
 		$this->initialize_stats();
@@ -5001,6 +5014,9 @@ 
 		return $url;
 	}
 
+	/**
+	 * @param string $actionurl
+	 */
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -5291,12 +5307,15 @@ 
 	 * @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 );
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public static function get_secrets( $action, $user_id ) {
 		$secrets = self::connection()->get_secrets( $action, $user_id );
 
@@ -5547,7 +5566,6 @@ 
 	 * @deprecated since 8.9.0
 	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
 	 *
-	 * @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 ) {
@@ -5640,6 +5658,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();
@@ -5721,6 +5740,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6293,9 +6315,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' ) ) {
@@ -6671,8 +6691,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
 	 */
@@ -6971,7 +6991,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

projects/plugins/jetpack/modules/sharedaddy/sharing-sources.php

Doc Comments +19 added lines

@@ -388,6 +388,9 @@ 
 		do_action( 'sharing_bump_stats', array( 'service' => $this, 'post' => $post ) );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function js_dialog( $name, $params = array() ) {
 		if ( true !== $this->open_link_in_new ) {
 			return;
@@ -1039,6 +1042,9 @@ 
 	public $icon = '\f204';
 	private $share_type = 'default';
 
+	/**
+	 * @param string $id
+	 */
 	public function __construct( $id, array $settings ) {
 		parent::__construct( $id, $settings );
 
@@ -1186,6 +1192,10 @@ 
 class Share_Print extends Sharing_Source {
 	public $shortname = 'print';
 	public $icon = '\f469';
+
+	/**
+	 * @param string $id
+	 */
 	public function __construct( $id, array $settings ) {
 		parent::__construct( $id, $settings );
 
@@ -1585,6 +1595,9 @@ 
 		return __( 'Pinterest', 'jetpack' );
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_image( $post ) {
 		if ( class_exists( 'Jetpack_PostImages' ) ) {
 			$image = Jetpack_PostImages::get_image( $post->ID, array( 'fallback_to_avatars' => true ) );
@@ -1724,6 +1737,9 @@ 
 	public $shortname = 'pocket';
 	public $icon = '\f224';
 
+	/**
+	 * @param string $id
+	 */
 	public function __construct( $id, array $settings ) {
 		parent::__construct( $id, $settings );
 
@@ -1839,6 +1855,9 @@ 
 class Jetpack_Share_WhatsApp extends Sharing_Source {
 	public $shortname = 'jetpack-whatsapp';
 
+	/**
+	 * @param string $id
+	 */
 	public function __construct( $id, array $settings ) {
 		parent::__construct( $id, $settings );
 	}

projects/plugins/jetpack/extensions/blocks/premium-content/_inc/subscription-service/class-token-subscription-service.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
 	/**
 	 * Get the token stored in the auth cookie.
 	 *
-	 * @return ?string
+	 * @return string
 	 */
 	private function token_from_cookie() {
 		if ( isset( $_COOKIE[ self::JWT_AUTH_TOKEN_COOKIE_NAME ] ) ) {

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/plugins/beta/class-jetpack-beta.php

Doc Comments +4 added lines, -2 removed lines

@@ -639,6 +639,7 @@ 
 	 * Fetch latest Jetpack version.
 	 *
 	 * @param bool $is_dev_version - If JP Dev version is being queried.
+	 * @return string
 	 */
 	public static function get_new_jetpack_version( $is_dev_version = false ) {
 		$manifest = self::get_beta_manifest();
@@ -714,6 +715,7 @@ 
 	 *
 	 * @param string $branch  - Branch.
 	 * @param string $section - Section.
+	 * @return string
 	 */
 	public static function get_install_url( $branch = null, $section = null ) {
 		if ( is_null( $section ) ) {
@@ -769,7 +771,7 @@ 
 	/**
 	 * Get JP plugin data.
 	 *
-	 * @param mixed $plugin_file - JP or JP Dev plugin path.
+	 * @param string $plugin_file - JP or JP Dev plugin path.
 	 */
 	public static function get_jetpack_plugin_info( $plugin_file = null ) {
 
@@ -1418,7 +1420,7 @@ 
 	/**
 	 * Checks if a dir is empty.
 	 *
-	 * @param [type] $dir The absolute directory path to check.
+	 * @param string $dir The absolute directory path to check.
 	 * @return boolean
 	 */
 	public static function is_dir_empty( $dir ) {

projects/plugins/beta/class-jetpack-beta-admin.php

Doc Comments +1 added lines

@@ -729,6 +729,7 @@
 	 *
 	 * @param string $branch - Branch that's ready for update.
 	 * @param string $section - What kind of branch we're updated (master, rc, pr).
+	 * @return string
 	 */
 	public static function update_action_url( $branch, $section ) {
 		$query = array(