Automattic / jetpack

sync/class.jetpack-sync-full.php

Doc Comments +7 added lines

@@ -188,6 +188,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	private function get_metadata( $ids, $meta_type ) {
 		global $wpdb;
 		$table = _get_meta_table( $meta_type );
@@ -214,6 +217,10 @@ 
 		$this->set_status("updates", 100);
 	}
 	
+	/**
+	 * @param string $name
+	 * @param integer $percent
+	 */
 	private function set_status( $name, $percent, $count = 1, $total =1 ) {
 		set_transient( self::$status_transient_name.'_'.$name, 
 			array( 

sync/class.jetpack-sync-queue.php

Doc Comments +9 added lines

@@ -7,6 +7,9 @@ 
 	public $id;
 	public $items_with_ids;
 
+	/**
+	 * @param string $id
+	 */
 	public function __construct( $id, $items_with_ids ) {
 		$this->id             = $id;
 		$this->items_with_ids = $items_with_ids;
@@ -31,6 +34,9 @@ 
 	public $id;
 	private $row_iterator;
 
+	/**
+	 * @param string $id
+	 */
 	function __construct( $id ) {
 		$this->id            = str_replace( '-', '_', $id ); // necessary to ensure we don't have ID collisions in the SQL
 		$this->row_iterator  = 0;
@@ -303,6 +309,9 @@ 
 		return get_transient( $this->get_checkout_transient_name() );
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		return set_transient( $this->get_checkout_transient_name(), $checkout_id, 5*60 ); // 5 minute timeout
 	}

sync/class.jetpack-sync-client.php

Doc Comments +21 added lines

@@ -195,21 +195,36 @@ 
 		$this->network_options_whitelist = $options;
 	}
 
+	/**
+	 * @param integer $size
+	 */
 	function set_send_buffer_memory_size( $size ) {
 		$this->checkout_memory_size = $size;
 	}
 
 	// in bytes
+
+	/**
+	 * @param integer $max_bytes
+	 */
 	function set_upload_max_bytes( $max_bytes ) {
 		$this->upload_max_bytes = $max_bytes;
 	}
 
 	// in rows
+
+	/**
+	 * @param integer $max_rows
+	 */
 	function set_upload_max_rows( $max_rows ) {
 		$this->upload_max_rows = $max_rows;
 	}
 
 	// in seconds
+
+	/**
+	 * @param integer $seconds
+	 */
 	function set_min_sync_wait_time( $seconds ) {
 		update_option( self::SYNC_THROTTLE_OPTION_NAME, $seconds, true );
 	}
@@ -476,6 +491,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $action_name
+	 */
 	private function buffer_includes_action( $buffer, $action_name ) {
 		foreach ( $buffer->get_items() as $item ) {
 			if ( $item[0] === $action_name ) {
@@ -505,6 +523,9 @@ 
 		return $post;
 	}
 
+	/**
+	 * @param string $when
+	 */
 	private function schedule_sync( $when ) {
 		wp_schedule_single_event( strtotime( $when ), 'jetpack_sync_actions' );
 	}

sync/class.jetpack-sync-wp-replicastore.php

Doc Comments +4 added lines

@@ -338,6 +338,10 @@
 	}
 
 	// functions
+
+	/**
+	 * @param string $name
+	 */
 	public function get_callable( $name ) {
 		$value = get_option( 'jetpack_' . $name );
 

modules/sso.php

Doc Comments +2 added lines, -2 removed lines

@@ -262,7 +262,7 @@ 
 	 * Validate the require  two step checkbox in Settings > General
 	 *
 	 * @since 2.7
-	 * @return boolean
+	 * @return integer
 	 **/
 	public function validate_jetpack_sso_require_two_step( $input ) {
 		return ( ! empty( $input ) ) ? 1 : 0;
@@ -287,7 +287,7 @@ 
 	 * Validate the match by email check in Settings > General
 	 *
 	 * @since 2.9
-	 * @return boolean
+	 * @return integer
 	 **/
 	public function validate_jetpack_sso_match_by_email( $input ) {
 		return ( ! empty( $input ) ) ? 1 : 0;

class.jetpack.php

Doc Comments +46 added lines, -14 removed lines

@@ -1018,7 +1018,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' );
@@ -1066,7 +1066,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 ''
@@ -1077,7 +1077,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();
@@ -1175,7 +1175,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' ) ) {
@@ -1985,7 +1985,7 @@ 
 	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
  	 *
 	 * @param string $name    Option name
-	 * @param mixed  $default (optional)
+	 * @param boolean  $default (optional)
 	 */
 	public static function get_option( $name, $default = false ) {
 		return Jetpack_Options::get_option( $name, $default );
@@ -1995,6 +1995,7 @@ 
 	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
 	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
 	* $name must be a registered option name.
+	* @param string $name
 	*/
 	public static function create_nonce( $name ) {
 		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
@@ -2052,6 +2053,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
@@ -2446,6 +2448,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
@@ -2474,7 +2477,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 );
@@ -2792,6 +2795,9 @@ 
 		$this->sync->sync_all_module_options( $module );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		/**
 		 * Fires when a module is deactivated.
@@ -2830,6 +2836,9 @@ 
 		return Jetpack_Options::update_option( 'active_modules', array_unique( $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' );
@@ -2840,21 +2849,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 );
@@ -2862,6 +2883,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3475,7 +3499,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();
@@ -4791,6 +4815,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4932,7 +4957,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 ) {
 	    $secret = wp_generate_password( 32, false ) // secret_1
@@ -5253,6 +5279,10 @@ 
 		return new WP_User( $token_details['user_id'] );
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5458,6 +5488,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5785,7 +5818,7 @@ 
 	/**
 	 * Pings the WordPress.com Mirror Site for the specified options.
 	 *
-	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
+	 * @param string[] $option_names The option names to request from the WordPress.com Mirror Site
 	 *
 	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
 	 */
@@ -5809,7 +5842,7 @@ 
 	/**
 	 * Fetch the filtered array of options that we should compare to determine an identity crisis.
 	 *
-	 * @return array An array of options to check.
+	 * @return string[] An array of options to check.
 	 */
 	public static function identity_crisis_options_to_check() {
 		return array(
@@ -6481,8 +6514,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
 	 */
@@ -6790,7 +6823,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
@@ -6881,7 +6914,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {