Automattic / jetpack

_inc/lib/tonesque.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
 	 * Construct object from image.
 	 *
 	 * @param optional $type (hex, rgb, hsv)
-	 * @return color as a string formatted as $type
+	 * @return false|string as a string formatted as $type
 	 *
  	 */
 	function color( $type = 'hex' ) {

modules/tiled-gallery/tiled-gallery/tiled-gallery-layout.php

Doc Comments +8 added lines

@@ -9,6 +9,11 @@ 
 	public $link;
 	public $grayscale;
 	public $columns;
+
+	/**
+	 * @param boolean $grayscale
+	 * @param integer $columns
+	 */
 	public function __construct( $attachments, $link, $grayscale, $columns ) {
 
 		$this->attachments           = $attachments;
@@ -39,6 +44,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private function template( $name, $context = null ) {
 		if ( ! in_array( $name, self::$templates ) ) {
 			return;

class.json-api.php

Doc Comments +18 added lines, -1 removed lines

@@ -33,6 +33,9 @@ 
 	public $extra_headers = array();
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -335,6 +338,9 @@ 
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit = $this->exit;
 		$this->exit = false;
@@ -543,11 +549,18 @@ 
 		return json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
 
 	// Returns the site's blog_id in the WP.com ecosystem
+
+	/**
+	 * @return integer
+	 */
 	function get_blog_id_for_output() {
 		return $this->token_details['blog_id'];
 	}
@@ -570,6 +583,10 @@ 
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -619,7 +636,7 @@ 
 	/**
 	 * Counts the number of comments on a site, excluding certain comment types.
 	 *
-	 * @param $post_id int Post ID.
+	 * @param integer $post_id int Post ID.
 	 * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
 	 */
 	public function wp_count_comments( $post_id ) {

class.photon.php

Doc Comments +1 added lines, -2 removed lines

@@ -213,7 +213,6 @@ 
 	/**
 	 * Inject image sizes to Jetpack REST API responses. This wraps the filter_photon_norezise_maybe_inject_sizes function.
 	 *
-	 * @param array $data          Attachment sizes data.
 	 * @param int   $attachment_id Attachment's post ID.
 	 *
 	 * @return array Attachment sizes array.
@@ -1257,7 +1256,7 @@ 
 	 * after ourselves without breaking anyone else's filters.
 	 *
 	 * @internal
-	 * @return true
+	 * @return boolean
 	 */
 	public function _override_image_downsize_in_rest_edit_context() {
 		return true;

class.jetpack-post-images.php

Doc Comments +3 added lines, -3 removed lines

@@ -162,6 +162,7 @@ 
 	/**
 	 * Get attachment images for a specified post and return them. Also make sure
 	 * their dimensions are at or above a required minimum.
+	 * @param integer $post_id
 	 */
 	static function from_attachment( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -224,7 +225,7 @@ 
 	 * Check if a Featured Image is set for this post, and return it in a similar
 	 * format to the other images?_from_*() methods.
 	 * @param  int $post_id The post ID to check
-	 * @return Array containing details of the Featured Image, or empty array if none.
+	 * @return integer|null containing details of the Featured Image, or empty array if none.
 	 */
 	static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -668,7 +669,6 @@ 
 	 * resized and cropped image.
 	 *
 	 * @param  string $src
-	 * @param  int    $dimension
 	 * @return string            Transformed image URL
 	 */
 	static function fit_image_url( $src, $width, $height ) {
@@ -715,7 +715,7 @@ 
 	 *
 	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
 	 *
-	 * @return array $html_info {
+	 * @return integer $html_info {
 	 * @type string $html     Post content.
 	 * @type string $post_url Post URL.
 	 * }

class.jetpack-gutenberg.php

Doc Comments +1 added lines, -1 removed lines

@@ -416,7 +416,7 @@
 	 * Only enqueue block assets when needed.
 	 *
 	 * @param string $type Slug of the block.
-	 * @param array  $script_dependencies Script dependencies. Will be merged with automatically
+	 * @param string[]  $script_dependencies Script dependencies. Will be merged with automatically
 	 *                                    detected script dependencies from the webpack build.
 	 *
 	 * @return void

class.jetpack.php

Doc Comments +36 added lines, -16 removed lines

@@ -716,7 +716,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 ) ) {
@@ -1236,7 +1236,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' );
@@ -1341,7 +1341,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 ''
@@ -1352,7 +1352,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();
@@ -1414,7 +1414,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' ) ) {
@@ -2145,6 +2145,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
@@ -2547,6 +2548,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
@@ -2583,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 );
@@ -2755,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.
@@ -3036,6 +3038,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' );
@@ -3064,6 +3069,9 @@ 
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3798,7 +3806,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();
@@ -4617,6 +4625,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 );
@@ -4676,6 +4687,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4867,6 +4879,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 ) {
@@ -5401,7 +5414,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 ) {
@@ -5411,6 +5423,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();
@@ -5556,6 +5572,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();
@@ -5612,6 +5629,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5694,6 +5714,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6244,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' ) ) {
@@ -6429,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
 	 */
@@ -6673,7 +6694,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();
@@ -6728,7 +6749,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {