Automattic / jetpack

json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

Doc Comments +3 added lines

@@ -107,6 +107,9 @@
 		$this->enqueue_action( current_filter(), func_get_args(), $this->sync_queue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	function enqueue_action( $current_filter, $args, $queue ) {
 
 		/**

sync/class.jetpack-sync-queue.php

Doc Comments +6 added lines

@@ -250,6 +250,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue_Buffer $buffer
+	 */
 	function close( $buffer, $ids_to_remove = null ) {
 		$is_valid = $this->validate_checkout( $buffer );
 
@@ -328,6 +331,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-sender.php

Doc Comments +10 added lines

@@ -52,6 +52,9 @@ 
 		return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
 	}
 
+	/**
+	 * @param integer $time
+	 */
 	public function set_next_sync_time( $time, $queue_name ) {
 		return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true );
 	}
@@ -64,6 +67,9 @@ 
 		return $this->do_sync_and_set_delays( $this->sync_queue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	public function do_sync_and_set_delays( $queue ) {
 		// don't sync if importing
 		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -293,6 +299,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}

sync/class.jetpack-sync-actions.php

Doc Comments +3 added lines

@@ -321,6 +321,9 @@
 		return self::DEFAULT_SYNC_CRON_INTERVAL;
 	}
 
+	/**
+	 * @param string $hook
+	 */
 	static function maybe_schedule_sync_cron( $schedule, $hook ) {
 		if ( ! $hook ) {
 			return;

sync/class.jetpack-sync-settings.php

Doc Comments +9 added lines

@@ -107,6 +107,9 @@ 
 		self::set_is_sending( null );
 	}
 
+	/**
+	 * @param boolean|null $is_importing
+	 */
 	static function set_importing( $is_importing ) {
 		// set to NULL to revert to WP_IMPORTING, the standard behaviour
 		self::$is_importing = $is_importing;
@@ -137,6 +140,9 @@ 
 		return (bool) self::$is_syncing;
 	}
 
+	/**
+	 * @param boolean|null $is_syncing
+	 */
 	static function set_is_syncing( $is_syncing ) {
 		self::$is_syncing = $is_syncing;
 	}
@@ -145,6 +151,9 @@ 
 		return (bool) self::$is_sending;
 	}
 
+	/**
+	 * @param boolean|null $is_sending
+	 */
 	static function set_is_sending( $is_sending ) {
 		self::$is_sending = $is_sending;
 	}

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

Doc Comments +10 added lines

@@ -420,6 +420,10 @@ 
 	}
 
 	// functions
+
+	/**
+	 * @param string $name
+	 */
 	public function get_callable( $name ) {
 		$value = get_option( 'jetpack_' . $name );
 
@@ -688,6 +692,9 @@ 
 		return $histogram;
 	}
 
+	/**
+	 * @param string|null $id_column
+	 */
 	private function table_checksum( $table, $columns, $id_column, $where_sql = '1=1', $min_id = null, $max_id = null, $strip_non_ascii = true ) {
 		global $wpdb;
 
@@ -725,6 +732,9 @@ 
 
 	}
 
+	/**
+	 * @param string $where_sql
+	 */
 	private function meta_count( $table, $where_sql, $min_id, $max_id ) {
 		global $wpdb;
 

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

Doc Comments +9 added lines

@@ -279,6 +279,9 @@ 
 		$listener->get_full_sync_queue()->reset();
 	}
 
+	/**
+	 * @param integer $default
+	 */
 	private function get_status_option( $name, $default = null ) {
 		$prefix = self::STATUS_OPTION_PREFIX;
 
@@ -313,6 +316,9 @@ 
 		return $this->read_option( 'jetpack_sync_full_config' );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private function write_option( $name, $value ) {
 		// we write our own option updating code to bypass filters/caching/etc on set_option/get_option
 		global $wpdb;
@@ -340,6 +346,9 @@ 
 		return $updated_num;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private function read_option( $name, $default = null ) {
 		global $wpdb;
 		$value = $wpdb->get_var( 

modules/protect/transient-cleanup.php

Doc Comments +1 added lines, -1 removed lines

@@ -1404,7 +1404,7 @@
 	/**
 	 * Migration routine for moving safecss from wp_options to wp_posts to support revisions
 	 *
-	 * @return void
+	 * @return false|null
 	 */
 	static function upgrade() {
 		$css = get_option( 'safecss' );

class.jetpack.php

Doc Comments +46 added lines, -13 removed lines

@@ -876,7 +876,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' );
@@ -976,7 +976,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 ''
@@ -987,7 +987,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();
@@ -1045,7 +1045,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' ) ) {
@@ -1619,7 +1619,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 );
@@ -1629,6 +1629,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 );
@@ -1686,6 +1687,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
@@ -2080,6 +2082,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
@@ -2108,7 +2111,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 );
@@ -2121,7 +2124,7 @@ 
 	 *
 	 * @param array $modules
 	 *
-	 * @return string|void
+	 * @return string
 	 */
 	public static function get_translated_modules( $modules ) {
 		foreach ( $modules as $index => $module ) {
@@ -2409,6 +2412,9 @@ 
 		_deprecated_function( __METHOD__, 'jeptack-4.2' );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		/**
 		 * Fires when a module is deactivated.
@@ -2437,6 +2443,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' );
@@ -2447,21 +2456,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 );
@@ -2469,6 +2490,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3102,7 +3126,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();
@@ -4137,6 +4161,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4281,7 +4306,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
@@ -4607,6 +4633,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();
@@ -4752,6 +4782,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();
@@ -4808,6 +4839,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5536,8 +5570,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
 	 */
@@ -5828,7 +5862,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
@@ -5919,7 +5953,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {