Automattic / 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 ) ) {

sync/class.jetpack-sync-module.php

Doc Comments +16 added lines

@@ -42,6 +42,9 @@ 
 		return array();
 	}
 
+	/**
+	 * @param string[] $actions_to_count
+	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
 	}
@@ -58,6 +61,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $action_name
+	 * @param string $id_field
+	 */
 	protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) {
 		global $wpdb;
 
@@ -111,6 +118,9 @@ 
 		return $chunks_with_ends;
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	protected function get_metadata( $ids, $meta_type, $meta_key_whitelist ) {
 		global $wpdb;
 		$table = _get_meta_table( $meta_type );
@@ -131,12 +141,18 @@ 
 		);
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	public function init_listeners_for_meta_type( $meta_type, $callable ) {
 		add_action( "added_{$meta_type}_meta", $callable, 10, 4 );
 		add_action( "updated_{$meta_type}_meta", $callable, 10, 4 );
 		add_action( "deleted_{$meta_type}_meta", $callable, 10, 4 );
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	public function init_meta_whitelist_handler( $meta_type, $whitelist_handler ) {
 		add_filter( "jetpack_sync_before_enqueue_added_{$meta_type}_meta", $whitelist_handler );
 		add_filter( "jetpack_sync_before_enqueue_updated_{$meta_type}_meta", $whitelist_handler );

sync/class.jetpack-sync-module-full-sync.php

Doc Comments +6 added lines

@@ -185,6 +185,9 @@ 
 		do_action( 'jetpack_full_sync_end', '', $range );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function get_range( $type ) {
 		global $wpdb;
 		if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) {
@@ -323,6 +326,9 @@ 
 		$listener->get_full_sync_queue()->reset();
 	}
 
+	/**
+	 * @param integer $default
+	 */
 	private function get_status_option( $name, $default = null ) {
 		$value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );
 

modules/carousel/jetpack-carousel.php

Doc Comments +12 added lines

@@ -129,6 +129,9 @@ 
 		return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false );
 	}
 
+	/**
+	 * @param string $version
+	 */
 	function asset_version( $version ) {
 		/**
 		 * Filter the version string used when enqueuing Carousel assets.
@@ -496,6 +499,9 @@ 
 		return $attr;
 	}
 
+	/**
+	 * @param string $html
+	 */
 	function add_data_to_container( $html ) {
 		global $post;
 		if ( Jetpack_AMP_Support::is_amp_request() ) {
@@ -739,6 +745,9 @@ 
 		return ( 1 == $value ) ? 1 : 0;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) {
 		if ( empty( $name ) ) {
 			return;
@@ -754,6 +763,9 @@ 
 		echo '</fieldset>';
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_select( $name, $values, $extra_text = '' ) {
 		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
 			return;

class.jetpack.php

Doc Comments +34 added lines, -17 removed lines

@@ -719,7 +719,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 ) ) {
@@ -1239,7 +1239,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' );
@@ -1344,7 +1344,7 @@ 
 	 * database which could be set to anything as opposed to what this function returns.
 	 * @param  bool  $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1355,7 +1355,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();
@@ -1417,7 +1417,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' ) ) {
@@ -2148,6 +2148,7 @@ 
 	 * @param int $user_id
 	 * @param string $token
 	 * return bool
+	 * @param boolean $is_master_user
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		// not designed for concurrent updates
@@ -2550,6 +2551,7 @@ 
 
 	/**
 	 * Like core's get_file_data implementation, but caches the result.
+	 * @param string $file
 	 */
 	public static function get_file_data( $file, $headers ) {
 		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
@@ -2586,7 +2588,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 );
@@ -2758,8 +2760,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.
@@ -3039,6 +3041,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3067,6 +3072,9 @@ 
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3801,7 +3809,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();
@@ -4620,6 +4628,9 @@ 
 		return $url;
 	}
 
+	/**
+	 * @return string
+	 */
 	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 );
@@ -4679,6 +4690,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4870,6 +4882,7 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
+	 * @param string $action
 	 * @return array
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
@@ -5404,7 +5417,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 ) {
@@ -5414,6 +5426,10 @@ 
 		return $this->rest_authentication_status;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5559,6 +5575,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();
@@ -5615,6 +5632,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6247,9 +6267,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' ) ) {
@@ -6432,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
 	 */
@@ -6667,7 +6685,7 @@ 
 	 *
 	 * @param string $option_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
 		// Bail if Jump Start has already been dismissed
@@ -6708,7 +6726,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();
@@ -6763,7 +6781,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {