Automattic / jetpack

_inc/lib/debugger/class-jetpack-cxn-tests.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * Helper function to look up the expected master user and return the local WP_User.
 	 *
-	 * @return WP_User Jetpack's expected master user.
+	 * @return string Jetpack's expected master user.
 	 */
 	protected function helper_retrieve_local_master_user() {
 		$master_user = Jetpack_Options::get_option( 'master_user' );

class.jetpack-post-images.php

Doc Comments +3 added lines, -3 removed lines

@@ -162,6 +162,7 @@ 
 	/**
 	 * Get attachment images for a specified post and return them. Also make sure
 	 * their dimensions are at or above a required minimum.
+	 * @param integer $post_id
 	 */
 	static function from_attachment( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -224,7 +225,7 @@ 
 	 * Check if a Featured Image is set for this post, and return it in a similar
 	 * format to the other images?_from_*() methods.
 	 * @param  int $post_id The post ID to check
-	 * @return Array containing details of the Featured Image, or empty array if none.
+	 * @return integer|null containing details of the Featured Image, or empty array if none.
 	 */
 	static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -668,7 +669,6 @@ 
 	 * resized and cropped image.
 	 *
 	 * @param  string $src
-	 * @param  int    $dimension
 	 * @return string            Transformed image URL
 	 */
 	static function fit_image_url( $src, $width, $height ) {
@@ -715,7 +715,7 @@ 
 	 *
 	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
 	 *
-	 * @return array $html_info {
+	 * @return integer $html_info {
 	 * @type string $html     Post content.
 	 * @type string $post_url Post URL.
 	 * }

_inc/lib/class.jetpack-password-checker.php

Doc Comments +1 added lines, -1 removed lines

@@ -410,7 +410,7 @@
 	 *
 	 * @param Mixed $needle the needle.
 	 * @param Array $haystack the haystack.
-	 * @return is the needle not in the haystack?
+	 * @return boolean the needle not in the haystack?
 	 */
 	protected function negative_in_array( $needle, $haystack ) {
 		if ( in_array( $needle, $haystack, true ) ) {

_inc/lib/class.media-summary.php

Doc Comments +6 added lines

@@ -271,6 +271,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	static function get_video_poster( $type, $id ) {
 		if ( 'videopress' == $type ) {
 			if ( function_exists( 'video_get_highest_resolution_image_url' ) ) {
@@ -356,6 +359,9 @@ 
 		return (int) count( self::split_content_in_words( self::clean_text( $post_content ) ) );
 	}
 
+	/**
+	 * @param string $excerpt_content
+	 */
 	static function get_word_remaining_count( $post_content, $excerpt_content ) {
 		$content_word_count = count( self::split_content_in_words( self::clean_text( $post_content ) ) );
 		$excerpt_word_count = count( self::split_content_in_words( self::clean_text( $excerpt_content ) ) ); 

_inc/lib/debugger/class-jetpack-cxn-test-base.php

Doc Comments +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
 	 * @param string $type  Test type, async or direct. Optional, direct all tests.
 	 * @param string $group Testing group to check status of. Optional, default all tests.
 	 *
-	 * @return true|array True if all tests pass. Array of failed tests.
+	 * @return boolean True if all tests pass. Array of failed tests.
 	 */
 	public function pass( $type = 'all', $group = 'all' ) {
 		$results = $this->raw_results( $type, $group );

packages/sync/src/Actions.php

Doc Comments +6 added lines

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

packages/sync/src/Functions.php

Doc Comments +7 added lines

@@ -148,6 +148,7 @@ 
 	 * Helper function that is used when getting home or siteurl values. Decides
 	 * whether to get the raw or filtered value.
 	 *
+	 * @param string $url_type
 	 * @return string
 	 */
 	public static function get_raw_or_filtered_url( $url_type ) {
@@ -197,6 +198,9 @@ 
 		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
 	}
 
+	/**
+	 * @param string $callable
+	 */
 	public static function get_protocol_normalized_url( $callable, $new_value ) {
 		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
 
@@ -236,6 +240,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $url_function
+	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );
 		$option_url = wp_parse_url( get_option( $option ) );

packages/sync/src/Listener.php

Doc Comments +3 added lines

@@ -177,6 +177,9 @@
 		$queue->add_all( $data_to_enqueue );
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	function enqueue_action( $current_filter, $args, $queue ) {
 		// don't enqueue an action during the outbound http request - this prevents recursion
 		if ( Settings::is_sending() ) {

packages/sync/src/Sender.php

Doc Comments +10 added lines

@@ -70,6 +70,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 );
 	}
@@ -100,6 +103,9 @@ 
 		return $this->do_sync_and_set_delays( $this->sync_queue );
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	public function do_sync_and_set_delays( $queue ) {
 		// don't sync if importing
 		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -357,6 +363,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}