Automattic / jetpack

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

Doc Comments +6 added lines

@@ -185,6 +185,9 @@ 
 		do_action( 'jetpack_full_sync_end', '', $range );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function get_range( $type ) {
 		global $wpdb;
 		if ( ! in_array( $type, array( 'comments', 'posts' ) ) ) {
@@ -323,6 +326,9 @@ 
 		$listener->get_full_sync_queue()->reset();
 	}
 
+	/**
+	 * @param integer $default
+	 */
 	private function get_status_option( $name, $default = null ) {
 		$value = Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );
 

packages/sync/legacy/class.jetpack-sync-module-users.php

Doc Comments +3 added lines

@@ -94,6 +94,9 @@
 		return $user;
 	}
 
+	/**
+	 * @param WP_User|null $user
+	 */
 	public function expand_user( $user ) {
 		if ( ! is_object( $user ) ) {
 			return null;

packages/sync/legacy/class.jetpack-sync-module.php

Doc Comments +16 added lines

@@ -42,6 +42,9 @@ 
 		return array();
 	}
 
+	/**
+	 * @param string[] $actions_to_count
+	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
 	}
@@ -58,6 +61,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $action_name
+	 * @param string $id_field
+	 */
 	protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) {
 		global $wpdb;
 
@@ -111,6 +118,9 @@ 
 		return $chunks_with_ends;
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	protected function get_metadata( $ids, $meta_type, $meta_key_whitelist ) {
 		global $wpdb;
 		$table = _get_meta_table( $meta_type );
@@ -131,12 +141,18 @@ 
 		);
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	public function init_listeners_for_meta_type( $meta_type, $callable ) {
 		add_action( "added_{$meta_type}_meta", $callable, 10, 4 );
 		add_action( "updated_{$meta_type}_meta", $callable, 10, 4 );
 		add_action( "deleted_{$meta_type}_meta", $callable, 10, 4 );
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	public function init_meta_whitelist_handler( $meta_type, $whitelist_handler ) {
 		add_filter( "jetpack_sync_before_enqueue_added_{$meta_type}_meta", $whitelist_handler );
 		add_filter( "jetpack_sync_before_enqueue_updated_{$meta_type}_meta", $whitelist_handler );

packages/sync/legacy/class.jetpack-sync-queue.php

Doc Comments +6 added lines

@@ -246,6 +246,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue_Buffer $buffer
+	 */
 	function close( $buffer, $ids_to_remove = null ) {
 		$is_valid = $this->validate_checkout( $buffer );
 
@@ -339,6 +342,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		global $wpdb;
 

packages/sync/legacy/class.jetpack-sync-sender.php

Doc Comments +10 added lines

@@ -76,6 +76,9 @@ 
 		return (float) 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 );
 	}
@@ -106,6 +109,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 ) {
@@ -354,6 +360,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}

packages/sync/legacy/class.jetpack-sync-settings.php

Doc Comments +9 added lines

@@ -135,6 +135,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 behavior
 		self::$is_importing = $is_importing;
@@ -165,6 +168,9 @@ 
 		return (bool) self::$is_syncing || ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST );
 	}
 
+	/**
+	 * @param boolean|null $is_syncing
+	 */
 	static function set_is_syncing( $is_syncing ) {
 		self::$is_syncing = $is_syncing;
 	}
@@ -173,6 +179,9 @@ 
 		return (bool) self::$is_sending;
 	}
 
+	/**
+	 * @param boolean|null $is_sending
+	 */
 	static function set_is_sending( $is_sending ) {
 		self::$is_sending = $is_sending;
 	}

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

Doc Comments +10 added lines

@@ -447,6 +447,10 @@ 
 	}
 
 	// functions
+
+	/**
+	 * @param string $name
+	 */
 	public function get_callable( $name ) {
 		$value = get_option( 'jetpack_' . $name );
 
@@ -738,6 +742,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, $salt = '' ) {
 		global $wpdb;
 
@@ -791,6 +798,9 @@ 
 		return 'sum';
 	}
 
+	/**
+	 * @param string $where_sql
+	 */
 	private function meta_count( $table, $where_sql, $min_id, $max_id ) {
 		global $wpdb;
 

tools/import-translations.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 /**
  * Converts GlotPress URL into a GlotPress API URL
  *
- * @param sring $url URL
+ * @param string $url URL
  * @return sstring API URL
  */
 function apize_url( $url ) {

class.jetpack.php

Doc Comments +25 added lines, -15 removed lines

@@ -759,7 +759,7 @@ 
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
 	 *
 	 * @param $domains
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_wpcom_domain( $domains ) {
 		if ( empty( $domains ) ) {
@@ -1279,7 +1279,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' );
@@ -1384,7 +1384,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 ''
@@ -1395,7 +1395,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();
@@ -1457,7 +1457,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' ) ) {
@@ -2613,7 +2613,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 );
@@ -2785,8 +2785,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.
@@ -3074,6 +3074,9 @@ 
 	}
 
 /* Installation */
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3807,7 +3810,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();
@@ -4689,6 +4692,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4697,6 +4701,7 @@ 
 
 	/**
 	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
+	 * @param string $url
 	 */
 	public static function fix_url_for_bad_hosts( $url ) {
 		if ( 0 !== strpos( $url, 'https://' ) ) {
@@ -4884,6 +4889,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 ) {
@@ -5392,7 +5398,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 ) {
@@ -5402,6 +5407,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();
@@ -5547,6 +5556,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();
@@ -5685,6 +5695,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public static function staticize_subdomain( $url ) {
 
 		// Extract hostname from URL
@@ -6235,9 +6248,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' ) ) {
@@ -6424,8 +6435,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
 	 */
@@ -6724,7 +6735,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {