Automattic / jetpack

class.jetpack-post-images.php

Doc Comments +2 added lines, -2 removed lines

@@ -166,6 +166,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();
@@ -232,7 +233,7 @@ 
 	 * 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();
@@ -687,7 +688,6 @@ 
 	 * resized and cropped image.
 	 *
 	 * @param  string $src
-	 * @param  int    $dimension
 	 * @return string            Transformed image URL
 	 */
 	static function fit_image_url( $src, $width, $height ) {

class.json-api-endpoints.php

Doc Comments +5 added lines

@@ -1534,6 +1534,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string $date_string Date to parse.
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1643,6 +1644,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {

packages/analyzer/src/Invocations/Function_Call.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 	public $line;
 	public $func_name;
 
+	/**
+	 * @param string $func_name
+	 */
 	public function __construct( $path, $line, $func_name ) {
 		$this->path      = $path;
 		$this->line      = $line;

_inc/lib/class.color.php

Doc Comments +13 added lines, -1 removed lines

@@ -149,6 +149,9 @@ 
 
 	/**
 	 * Helper function for Jetpack_Color::fromHsl()
+	 * @param double $p
+	 * @param double $q
+	 * @param integer $t
 	 */
 	private function hue2rgb( $p, $q, $t ) {
 		if ( $t < 0 ) $t += 1;
@@ -498,7 +501,7 @@ 
 	 *
 	 * @param Jetpack_Color $color
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getDistanceRgbFrom(Jetpack_Color $color)
 	{
@@ -687,6 +690,9 @@ 
 		return $this->incrementLightness( $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementLightness( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -704,6 +710,9 @@ 
 		return $this->incrementSaturation( - $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementSaturation( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -744,6 +753,9 @@ 
 		return $this->incrementHue( $incr );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementHue( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );

sal/class.json-api-links.php

Doc Comments +2 added lines, -1 removed lines

@@ -30,6 +30,7 @@ 
 	 * Used to construct meta links in API responses
 	 *
 	 * @param mixed ...$args Optional arguments to be appended to URL
+	 * @param string $args
 	 * @return string Endpoint URL
 	 **/
 	function get_link( ...$args ) {
@@ -128,7 +129,7 @@ 
 	 * This method is used in get_link() to construct meta links for API responses.
 	 *
 	 * @param $template_path string The generic endpoint path, e.g. /sites/%s
-	 * @param $path string The current endpoint path, relative to the version, e.g. /sites/12345
+	 * @param string $path string The current endpoint path, relative to the version, e.g. /sites/12345
 	 * @param $request_method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */

_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 ) ) );

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

Doc Comments +6 added lines

@@ -43,6 +43,9 @@ 
 		return array( 'scheduled' => Actions::do_full_sync( $modules ) );
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function validate_queue( $query ) {
 		if ( ! isset( $query ) ) {
 			return new WP_Error( 'invalid_queue', 'Queue name is required', 400 );
@@ -233,6 +236,9 @@ 
 		);
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	protected function get_buffer( $queue, $number_of_items ) {
 		$start = time();
 		$max_duration = 5; // this will try to get the buffer

packages/analyzer/src/Dependencies/Dependency.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
 	public $declaration;
 	public $invocation_root;
 
+	/**
+	 * @param string $invocation_root
+	 */
 	function __construct( $invocation, $declaration, $invocation_root = null ) {
 		$this->invocation      = $invocation;
 		$this->declaration     = $declaration;

packages/connection/legacy/class-jetpack-signature.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
 	 * @param string $url              Request URL.
 	 * @param mixed  $body             Request body.
 	 * @param bool   $verify_body_hash Whether to verify the body hash against the body.
-	 * @return string|WP_Error Request signature, or a WP_Error on failure.
+	 * @return string Request signature, or a WP_Error on failure.
 	 */
 	public function sign_request( $token = '', $timestamp = 0, $nonce = '', $body_hash = '', $method = '', $url = '', $body = null, $verify_body_hash = true ) {
 		if ( ! $this->secret ) {