Automattic / jetpack

_inc/lib/jetpack-wpes-query-builder/jetpack-wpes-query-parser.php

Doc Comments +4 added lines

@@ -147,6 +147,10 @@
 	 * Take a list of field prefixes and expand them for multi-lingual
 	 * with the provided boostings.
 	 */
+
+	/**
+	 * @param string[] $additional_fields
+	 */
 	public function merge_ml_fields( $fields2boosts, $additional_fields ) {
 		$flds = array();
 		foreach( $fields2boosts as $f => $b ) {

_inc/lib/class.jetpack-search-performance-logger.php

Doc Comments +4 added lines

@@ -58,6 +58,10 @@
 		return $query->is_main_query() && $query->is_search();
 	}
 
+	/**
+	 * @param double $duration
+	 * @param boolean $was_jetpack_search
+	 */
 	private function record_query_time( $duration, $was_jetpack_search ) {
 		$this->stats[] = array( $was_jetpack_search, intval( $duration * 1000 ) );
 	}

modules/search/class.jetpack-search-helpers.php

Doc Comments -1 removed lines

@@ -76,7 +76,6 @@
 	 * @since 5.8.0
 	 *
 	 * @param string|array $key   Query key or keys to remove.
-	 * @param bool|string  $query Optional. A URL to act upon.  Defaults to the current search URL.
 	 *
 	 * @return string New URL query string (unescaped).
 	 */

_inc/lib/markdown/extra.php

Doc Comments +27 added lines, -1 removed lines

@@ -69,7 +69,7 @@ 
  *
  * @since 5.9
  *
- * @return string Length of the multibyte string
+ * @return integer Length of the multibyte string
  *
  */
 function jetpack_utf8_strlen( $text ) {
@@ -169,6 +169,9 @@ 
 	}
 
 
+	/**
+	 * @param string $text
+	 */
 	function transform($text) {
 	#
 	# Main function. Performs some preprocessing on the input text
@@ -903,6 +906,10 @@ 
 
 	public $list_level = 0;
 
+	/**
+	 * @param string $list_str
+	 * @param string $marker_any_re
+	 */
 	function processListItems($list_str, $marker_any_re) {
 	#
 	#	Process the contents of a single ordered or unordered list, splitting it
@@ -1006,6 +1013,9 @@ 
 	}
 
 
+	/**
+	 * @param string $code
+	 */
 	function makeCodeSpan($code) {
 	#
 	# Create a code span markup for $code. Called from handleSpanToken.
@@ -1498,6 +1508,9 @@ 
 	# hanlde UTF-8 if the default function does not exist.
 	public $utf8_strlen = 'mb_strlen';
 
+	/**
+	 * @param string $text
+	 */
 	function detab($text) {
 	#
 	# Replace tabs with the appropriate amount of space.
@@ -2042,6 +2055,12 @@ 
 
 		return array($parsed, $text);
 	}
+
+	/**
+	 * @param string $text
+	 * @param string $hash_method
+	 * @param boolean $md_attr
+	 */
 	function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr) {
 	#
 	# Parse HTML, calling _HashHTMLBlocks_InMarkdown for block tags.
@@ -2706,6 +2725,9 @@ 
 	}
 
 
+	/**
+	 * @return string
+	 */
 	function processDefListItems($list_str) {
 	#
 	#	Process the contents of a single definition list, splitting it
@@ -2817,6 +2839,10 @@ 
 
 		return $text;
 	}
+
+	/**
+	 * @param string[] $matches
+	 */
 	function _doFencedCodeBlocks_callback($matches) {
 		$classname =& $matches[2];
 		$attrs     =& $matches[3];

docker/mu-plugins/debug.php

Doc Comments +1 added lines

@@ -40,6 +40,7 @@
  * l($arg1, $arg2) will call l($arg1) and l($arg2) and then return $arg1.
  *
  * A null argument will log the file and line number of the l() call.
+ * @param string $stuff
  */
 function l( $stuff = null ) {
 	// Do nothing when debugging is off

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

Doc Comments +2 added lines, -2 removed lines

@@ -292,7 +292,7 @@ 
 	/**
 	 * Get the current user id
 	 *
-	 * @return int
+	 * @return string
 	 */
 	public function get_user_id() {
 		if ( is_user_logged_in() ) {
@@ -325,7 +325,7 @@ 
 	/**
 	 * @param $product_id
 	 * @param $quantity
-	 * @param $event
+	 * @param string $event
 	 */
 	public function capture_event_in_session_data( $product_id, $quantity, $event ) {
 

_inc/class.jetpack-provision.php

Doc Comments +3 added lines

@@ -249,6 +249,9 @@
 		}
 	}
 
+	/**
+	 * @param string $access_token
+	 */
 	private static function verify_token( $access_token ) {
 		$request = array(
 			'headers' => array(

modules/wordads/wordads.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	 * Convenience function for grabbing options from params->options
 	 *
 	 * @param  string $option the option to grab
-	 * @param  mixed  $default (optional)
+	 * @param  boolean  $default (optional)
 	 * @return option or $default if not set
 	 *
 	 * @since 4.5.0
@@ -465,7 +465,7 @@ 
 
 	/**
 	 * Check the reasons to bail before we attempt to insert ads.
-	 * @return true if we should bail (don't insert ads)
+	 * @return boolean if we should bail (don't insert ads)
 	 *
 	 * @since 4.5.0
 	 */

class.jetpack.php

Doc Comments +42 added lines, -16 removed lines

@@ -1112,7 +1112,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' );
@@ -1217,7 +1217,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 ''
@@ -1228,7 +1228,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();
@@ -1290,7 +1290,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' ) ) {
@@ -2119,6 +2119,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
@@ -2521,6 +2522,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
@@ -2557,7 +2559,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 );
@@ -2672,8 +2674,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.
@@ -2953,6 +2955,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' );
@@ -2963,21 +2968,33 @@ 
 		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_load( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_load_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_head( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_head_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_activation_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'display_activate_module_setting_' . $module, $method );
@@ -2985,6 +3002,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3741,7 +3761,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();
@@ -4843,6 +4863,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -5034,6 +5055,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 ) {
@@ -5586,7 +5608,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 ) {
@@ -5596,6 +5617,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();
@@ -5741,6 +5766,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();
@@ -5797,6 +5823,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6414,9 +6443,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' ) ) {
@@ -6593,8 +6620,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
 	 */
@@ -6823,7 +6850,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
@@ -6864,7 +6891,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();
@@ -6910,7 +6937,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {