Automattic / jetpack

_inc/lib/class.color.php

Doc Comments +14 added lines, -2 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;
@@ -278,7 +281,7 @@ 
 	 * Get HSV values for color
 	 * (integer values from 0-255, fast but less accurate)
 	 *
-	 * @return int
+	 * @return string
 	 */
 	public function toHsvInt()
 	{
@@ -498,7 +501,7 @@ 
 	 *
 	 * @param Jetpack_Color $color
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getDistanceRgbFrom(Jetpack_Color $color)
 	{
@@ -682,6 +685,9 @@ 
 		return $this->incrementLightness( $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementLightness( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -699,6 +705,9 @@ 
 		return $this->incrementSaturation( - $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementSaturation( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -739,6 +748,9 @@ 
 		return $this->incrementHue( $incr );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementHue( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );

_inc/lib/class.media-extractor.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	 * NOTE: If you want IMAGES, call extract( $blog_id, $post_id, ...) which will give you more/better image extraction
 	 * This method will give you an error if you ask for IMAGES.
 	 *
-	 * @param $content The HTML post_content of a post
+	 * @param string $content The HTML post_content of a post
 	 * @param $what_to_extract (int) A mask of things to extract, e.g. Jetpack_Media_Meta_Extractor::IMAGES | Jetpack_Media_Meta_Extractor::MENTIONS
 	 * @param $already_extracted (array) Previously extracted things, e.g. images from extract(), which can be used for x-referencing here
 	 * @returns a structure containing metadata about the embedded things, or empty array if nothing found, or WP_Error on error

_inc/lib/icalendar-reader.php

Doc Comments +2 added lines, -4 removed lines

@@ -699,8 +699,7 @@ 
 	 * Render the events
 	 *
 	 * @param string $url (default: '')
-	 * @param string $context (default: 'widget') or 'shortcode'
-	 * @return mixed bool|string false on failure, rendered HTML string on success.
+	 * @return false|string bool|string false on failure, rendered HTML string on success.
 	 */
 	public function render( $url = '', $args = array() ) {
 
@@ -857,8 +856,7 @@ 
  * Wrapper function for iCalendarReader->render()
  *
  * @param string $url (default: '')
- * @param string $context (default: 'widget') or 'shortcode'
- * @return mixed bool|string false on failure, rendered HTML string on success.
+ * @return false|string bool|string false on failure, rendered HTML string on success.
  */
 function icalendar_render_events( $url = '', $args = array() ) {
 	$ical = new iCalendarReader();

3rd-party/domain-mapping.php

Doc Comments +10 added lines

@@ -93,14 +93,24 @@
 	 * So that we can test.
 	 */
 
+	/**
+	 * @param string $class
+	 * @param string $method
+	 */
 	public function method_exists( $class, $method ) {
 		return method_exists( $class, $method );
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function class_exists( $class ) {
 		return class_exists( $class );
 	}
 
+	/**
+	 * @param string $function
+	 */
 	public function function_exists( $function ) {
 		return function_exists( $function );
 	}

class.jetpack-autoupdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 	/**
 	 * Iterates through expected items ( plugins or themes ) and compares them to actual results.
 	 *
-	 * @param $items 'plugin' or 'theme'
+	 * @param string $items 'plugin' or 'theme'
 	 */
 	private function log_items( $items ) {
 		if ( ! isset( $this->expected[ $items ] ) ) {

_inc/lib/jetpack-wpes-query-builder/jetpack-wpes-query-builder.php

Doc Comments +5 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html
 	 *
-	 * @param $function string name of the function
+	 * @param string $function string name of the function
 	 * @param $params array functions parameters
 	 *
 	 * @return void
@@ -94,7 +94,7 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/decay-functions.html
 	 *
-	 * @param $function string name of the decay function - linear, exp, or gauss
+	 * @param string $function string name of the decay function - linear, exp, or gauss
 	 * @param $params array The decay functions parameters, passed to ES directly
 	 *
 	 * @return void
@@ -124,6 +124,9 @@ 
 		$this->query_bool_boost = $boost;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;

3rd-party/qtranslate-x.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  * @param string $url_orig Original URL.
  * @param array $url_info  Pieces of original URL.
  *
- * @return bool
+ * @return false|string
  */
 function jetpack_no_qtranslate_rest_url_redirect( $url_lang, $url_orig, $url_info ) {
 	if ( false !== strpos( $url_info['wp-path'], 'wp-json/jetpack' ) ) {

_inc/lib/class.core-rest-api-endpoints.php

Doc Comments -2 removed lines

@@ -598,7 +598,6 @@ 
 	 * @uses Jetpack::disconnect();
 	 * @since 4.3.0
 	 *
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
 	 *
 	 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
 	 */
@@ -618,7 +617,6 @@ 
 	 *
 	 * @since 4.3.0
 	 *
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
 	 *
 	 * @return object
 	 */

_inc/lib/functions.wp-notify.php

Doc Comments +1 added lines, -1 removed lines

@@ -201,7 +201,7 @@
 	 * should be notified, overriding the site setting.
 	 *
 	 * @param int $comment_id Comment ID.
-	 * @return true Always returns true.
+	 * @return boolean Always returns true.
 	 */
 	function wp_notify_moderator( $comment_id ) {
 		global $wpdb;