Automattic / jetpack

sal/class.json-api-site-jetpack-base.php

Doc Comments +15 added lines

@@ -4,12 +4,27 @@
 require_once dirname( __FILE__ ) . '/class.json-api-site-base.php';
 
 abstract class Abstract_Jetpack_Site extends SAL_Site {
+
+	/**
+	 * @param string $name
+	 */
 	abstract protected function get_constant( $name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function current_theme_supports( $feature_name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function get_theme_support( $feature_name );
 
+	/**
+	 * @param string $name
+	 *
+	 * @return string
+	 */
 	abstract protected function get_mock_option( $name );
 
 	abstract protected function get_jetpack_version();

sal/class.json-api-post-base.php

Doc Comments +7 added lines

@@ -16,6 +16,9 @@ 
 	public $context;
 	public $site;
 
+	/**
+	 * @param Jetpack_Site $site
+	 */
 	function __construct( $site, $post, $context ) {
 		$this->post = $post;
 		$this->context = $context;
@@ -487,6 +490,10 @@ 
 		return $suggestions;
 	}
 
+	/**
+	 * @param string $taxonomy_type
+	 * @param string $context
+	 */
 	private function format_taxonomy( $taxonomy, $taxonomy_type, $context ) {
 		// Permissions
 		switch ( $context ) {

sal/class.json-api-site-base.php

Doc Comments +6 added lines

@@ -16,6 +16,9 @@ 
 	public $blog_id;
 	public $platform;
 
+	/**
+	 * @param WPORG_Platform $platform
+	 */
 	public function __construct( $blog_id, $platform ) {
 		$this->blog_id = $blog_id;
 		$this->platform = $platform;
@@ -92,6 +95,9 @@ 
 	abstract public function wrap_post( $post, $context );
 
 
+	/**
+	 * @param string $context
+	 */
 	public function get_post_by_id( $post_id, $context ) {
 		$post = get_post( $post_id, OBJECT, $context );
 

class.jetpack.php

Doc Comments +42 added lines, -11 removed lines

@@ -1026,7 +1026,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' );
@@ -1074,7 +1074,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 ''
@@ -1085,7 +1085,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();
@@ -1724,7 +1724,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 );
@@ -1734,6 +1734,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 );
@@ -1791,6 +1792,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
@@ -2185,6 +2187,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
@@ -2213,7 +2216,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 );
@@ -2529,6 +2532,9 @@ 
 		do_action( "jetpack_activate_module_$module", $module );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		/**
 		 * Fires when a module is deactivated.
@@ -2567,6 +2573,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' );
@@ -2577,21 +2586,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 );
@@ -2599,6 +2620,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3185,7 +3209,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();
@@ -4480,6 +4504,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4906,6 +4931,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();
@@ -5111,6 +5140,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5438,7 +5470,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
 	 */
@@ -5462,7 +5494,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(
@@ -6133,8 +6165,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
 	 */
@@ -6530,7 +6562,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

sync/class.jetpack-sync-queue.php

Doc Comments +9 added lines

@@ -30,6 +30,9 @@ 
 	public $id;
 	private $checkout_size;
 
+	/**
+	 * @param string $id
+	 */
 	function __construct( $id, $checkout_size = 10 ) {
 		$this->id = str_replace( '-', '_', $id); // necessary to ensure we don't have ID collisions in the SQL
 		$this->checkout_size = $checkout_size;
@@ -127,6 +130,9 @@ 
 		return get_option( "jetpack_sync_queue_{$this->id}-checkout", false );
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		return add_option( "jetpack_sync_queue_{$this->id}-checkout", $checkout_id, null, true ); // this one we should autoload
 	}
@@ -145,6 +151,9 @@ 
 		return 'jetpack_sync_queue_'.$this->id.'-'.$timestamp.'-'.getmypid();
 	}
 
+	/**
+	 * @param integer $limit
+	 */
 	private function fetch_items( $limit = null ) {
 		global $wpdb;
 

class.jetpack-data.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
 	/**
 	 * This function mirrors Jetpack_Data::is_usable_domain() in the WPCOM codebase.
 	 *
-	 * @param $domain
+	 * @param string|false $domain
 	 * @param array $extra
 	 *
 	 * @return bool|WP_Error

sync/class.jetpack-sync-client.php

Doc Comments +6 added lines

@@ -467,6 +467,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $action_name
+	 */
 	private function buffer_includes_action( $buffer, $action_name ) {
 		foreach( $buffer->get_items() as $item ) {
 			if ( $item[0] === $action_name ) {
@@ -476,6 +479,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $when
+	 */
 	private function schedule_sync( $when ) {
 		wp_schedule_single_event( strtotime( $when ), 'jetpack_sync_actions' );
 	}

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(