Automattic / jetpack

sync/class.jetpack-sync-options.php

Doc Comments +6 added lines

@@ -119,6 +119,9 @@ 
 		return $default;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function update_grouped_option( $group, $name, $value ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( ! is_array( $options ) ) {
@@ -217,6 +220,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function get_grouped_option( $group, $name, $default ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( is_array( $options ) && isset( $options[ $name ] ) ) {

modules/shortcodes/archiveorg.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
  *
  * @param string $content
  *
- * @return mixed
+ * @return string
  */
 function jetpack_archiveorg_embed_to_shortcode( $content ) {
 	if ( false === stripos( $content, 'archive.org/embed/' ) )

modules/wordads/php/api.php

Doc Comments +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 
 	/**
 	 * Returns status of WordAds approval.
-	 * @return boolean true if site is WordAds approved
+	 * @return string true if site is WordAds approved
 	 *
 	 * @since 4.5.0
 	 */
@@ -59,7 +59,7 @@ 
 
 	/**
 	 * Returns status of WordAds active.
-	 * @return boolean true if ads are active on site
+	 * @return string true if ads are active on site
 	 *
 	 * @since 4.5.0
 	 */
@@ -73,7 +73,7 @@ 
 
 	/**
 	 * Returns status of WordAds house ads.
-	 * @return boolean true if WP.com house ads should be shown
+	 * @return string true if WP.com house ads should be shown
 	 *
 	 * @since 4.5.0
 	 */

modules/shortcodes/class.filter-embedded-html-objects.php

Doc Comments +6 added lines

@@ -90,6 +90,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $regexp
+	 */
 	static public function regexp_entities( $regexp ) {
 		return preg_replace(
 			'/\[\^&([^\]]+)\]\*\+/',
@@ -128,6 +131,9 @@ 
 		return self::dispatch( $matches );
 	}
 
+	/**
+	 * @param string[] $matches
+	 */
 	static function dispatch( $matches ) {
 		$html  = preg_replace( '%&#0*58;//%', '://', $matches[0] );
 		$attrs = self::get_attrs( $html );

modules/theme-tools/content-options/blog-display.php

Doc Comments +1 added lines

@@ -138,6 +138,7 @@
 /**
  * Returns a class value, `output-the-content` by default.
  * Used for themes with a 'Mixed' Blog Display so we can tell which output is by default.
+ * @param string $new_class
  */
 function jetpack_the_content_customizer_class( $new_class = null ) {
 	static $class;

modules/shortcodes/googleapps.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
  *
  * @param string $content
  *
- * @return mixed
+ * @return string
  */
 function jetpack_archiveorg_embed_to_shortcode( $content ) {
 	if ( false === stripos( $content, 'archive.org/embed/' ) )

sync/class.jetpack-sync-actions.php

Doc Comments +6 added lines

@@ -298,6 +298,9 @@ 
 		return $sync_modules;
 	}
 
+	/**
+	 * @return string
+	 */
 	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
 		$schedule = sanitize_key( $schedule );
 		$schedules = wp_get_schedules();
@@ -333,6 +336,9 @@ 
 		) );
 	}
 
+	/**
+	 * @param string $hook
+	 */
 	static function maybe_schedule_sync_cron( $schedule, $hook ) {
 		if ( ! $hook ) {
 			return;

class.jetpack.php

Doc Comments +42 added lines, -13 removed lines

@@ -893,7 +893,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' );
@@ -998,7 +998,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 ''
@@ -1009,7 +1009,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();
@@ -1071,7 +1071,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' ) ) {
@@ -1280,6 +1280,7 @@ 
 	 * @access public
 	 * @static
 	 *
+	 * @param string $feature
 	 * @return bool True if plan supports feature, false if not
 	 */
 	public static function active_plan_supports( $feature ) {
@@ -1836,6 +1837,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
@@ -2230,6 +2232,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
@@ -2258,7 +2261,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 );
@@ -2271,7 +2274,7 @@ 
 	 *
 	 * @param array $modules
 	 *
-	 * @return string|void
+	 * @return string
 	 */
 	public static function get_translated_modules( $modules ) {
 		foreach ( $modules as $index => $module ) {
@@ -2600,6 +2603,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' );
@@ -2610,21 +2616,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 );
@@ -2632,6 +2650,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3280,7 +3301,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();
@@ -4278,6 +4299,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4422,7 +4444,8 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
-	 * @return array
+	 * @param string $action
+	 * @return string
 	 */
 	public function generate_secrets( $action, $exp = 600 ) {
 	    $secret = wp_generate_password( 32, false ) // secret_1
@@ -4861,7 +4884,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 ) {
@@ -4871,6 +4893,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();
@@ -5016,6 +5042,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();
@@ -5072,6 +5099,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5821,8 +5851,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
 	 */
@@ -6113,7 +6143,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
@@ -6204,7 +6234,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {