Automattic / jetpack

projects/plugins/jetpack/_inc/lib/jetpack-wpes-query-builder/jetpack-wpes-query-builder.php

Doc Comments +9 added lines, -6 removed lines

@@ -91,7 +91,7 @@ 
 	 *
 	 * @param $function array A function structure to apply to the query
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_weighting_function( $function ) {
 		// check for danger.
@@ -114,10 +114,10 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html
 	 *
-	 * @param $function string name of the function
+	 * @param string $function string name of the function
 	 * @param $params array functions parameters
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_function( $function, $params ) {
 		$this->functions[ $function ][] = $params;
@@ -133,10 +133,10 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/decay-functions.html
 	 *
-	 * @param $function string name of the decay function - linear, exp, or gauss
+	 * @param string $function string name of the decay function - linear, exp, or gauss
 	 * @param $params array The decay functions parameters, passed to ES directly
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_decay( $function, $params ) {
 		$this->decays[ $function ][] = $params;
@@ -151,7 +151,7 @@ 
 	 *
 	 * @param $mode string name of how to score
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_score_mode_to_functions( $mode='multiply' ) {
 		$this->functions_score_mode = $mode;
@@ -177,6 +177,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;

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(

projects/plugins/jetpack/_inc/lib/functions.wp-notify.php

Doc Comments +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
  *
  * @param string $notify_moderator The value of the moderation_notify option OR if the comment is awaiting moderation.
  * @param int    $comment_id Comment ID.
- * @return boolean Returns false to shortcircuit the execution of wp_notify_moderator
+ * @return string|false Returns false to shortcircuit the execution of wp_notify_moderator
  */
 function jetpack_notify_moderator( $notify_moderator, $comment_id ) {
 	/*

projects/packages/autoloader/src/CustomAutoloaderPlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 	/**
 	 * Checks to see whether or not the root package is the one that required the autoloader.
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 */
 	private function isRequiredByRoot() {
 		$package  = $this->composer->getPackage();

projects/plugins/jetpack/modules/memberships/class-jetpack-memberships.php

Doc Comments +2 added lines, -2 removed lines

@@ -193,7 +193,7 @@ 
 	 * @param array $post_types - other post types.
 	 *
 	 * @see hook 'rest_api_allowed_post_types'
-	 * @return array
+	 * @return string[]
 	 */
 	public function allow_rest_api_types( $post_types ) {
 		$post_types[] = self::$post_type_plan;
@@ -254,7 +254,7 @@ 
 	 * (because it requires a plan upgrade or Stripe connection), and the
 	 * button is a child of a Premium Content block.
 	 *
-	 * @param WP_Block $block Recurring Payments block instance.
+	 * @param WP_Block|null $block Recurring Payments block instance.
 	 *
 	 * @return boolean
 	 */

projects/plugins/jetpack/class.jetpack.php

Doc Comments +37 added lines, -17 removed lines

@@ -979,7 +979,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 ) ) {
@@ -1380,7 +1380,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' );
@@ -1490,7 +1490,7 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1501,7 +1501,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();
@@ -1564,7 +1564,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' ) ) {
@@ -2272,7 +2272,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' );
@@ -2755,7 +2755,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 );
@@ -2870,8 +2870,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.
@@ -2882,6 +2882,11 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 * @param boolean $requires_user_connection
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3171,6 +3176,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' );
@@ -3199,6 +3207,10 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3244,6 +3256,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 );
@@ -3965,7 +3978,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();
@@ -4706,6 +4719,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();
@@ -5140,6 +5154,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 );
@@ -5430,12 +5447,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 );
 
@@ -5686,7 +5706,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 ) {
@@ -5779,6 +5798,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();
@@ -5860,6 +5880,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6432,9 +6455,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' ) ) {
@@ -6810,8 +6831,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
 	 */
@@ -7113,7 +7134,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {