Automattic / jetpack

modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php

Doc Comments +2 added lines, -2 removed lines

@@ -292,7 +292,7 @@ 
 	/**
 	 * Get the current user id
 	 *
-	 * @return int
+	 * @return string
 	 */
 	public function get_user_id() {
 		if ( is_user_logged_in() ) {
@@ -325,7 +325,7 @@ 
 	/**
 	 * @param $product_id
 	 * @param $quantity
-	 * @param $event
+	 * @param string $event
 	 */
 	public function capture_event_in_session_data( $product_id, $quantity, $event ) {
 

_inc/class.jetpack-provision.php

Doc Comments +3 added lines

@@ -249,6 +249,9 @@
 		}
 	}
 
+	/**
+	 * @param string $access_token
+	 */
 	private static function verify_token( $access_token ) {
 		$request = array(
 			'headers' => array(

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

Doc Comments +3 added lines

@@ -177,6 +177,9 @@
 		return true;
 	}
 
+	/**
+	 * @param string $role
+	 */
 	function current_user_can( $role ) {
 		return current_user_can( $role );
 	}

_inc/lib/class.media.php

Doc Comments +7 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
 	/**
 	 * Return an array of allowed mime_type items used to upload a media file.
 	 * 	
-	 * @return array mime_type array
+	 * @return string[] mime_type array
 	 */
 	static function get_allowed_mime_types( $default_mime_types ) {
 		return array_unique( array_merge( $default_mime_types, array(
@@ -253,7 +253,7 @@ 
 	 * @param  object $media_item - media post object
 	 * @param  file $file - file recently added
 	 * @param  bool $has_original_media - condition is the original media has been already added
-	 * @return bool `true` if the item has been added. Otherwise `false`.
+	 * @return false|null `true` if the item has been added. Otherwise `false`.
 	 */
 	public static function register_revision( $media_item, $file, $has_original_media ) {
 		if ( is_wp_error( $file ) || ! $has_original_media ) {
@@ -281,6 +281,9 @@ 
 		return $original;
 	}
 
+	/**
+	 * @param string $pathname
+	 */
 	public static function delete_file( $pathname ) {
 		if ( ! file_exists( $pathname ) || ! is_file( $pathname ) ) {
 			// let's touch a fake file to try to `really` remove the media file
@@ -296,7 +299,7 @@ 
 	 * 
 	 * @param  number $media_id - media post ID
 	 * @param  string $filename - basename of the file ( name-of-file.ext )
-	 * @return bool `true` is the file has been removed, `false` if not.
+	 * @return boolean|null `true` is the file has been removed, `false` if not.
 	 */
 	private static function delete_media_history_file( $media_id, $filename ) {
 		$attached_path = get_attached_file( $media_id );
@@ -366,6 +369,7 @@ 
 	 * 
 	 * @param  number $media_id - media post ID
 	 * @param  number [$limit] - maximun amount of items. 20 as default.
+	 * @param integer $limit
 	 * @return array items removed from `revision_history`
 	 */
 	public static function limit_revision_history( $media_id, $limit = null) {

_inc/lib/tonesque.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
 	 * Construct object from image.
 	 *
 	 * @param optional $type (hex, rgb, hsv)
-	 * @return color as a string formatted as $type
+	 * @return false|string as a string formatted as $type
 	 *
  	 */
 	function color( $type = 'hex' ) {

modules/widgets/simple-payments.php

Doc Comments +3 added lines, -3 removed lines

@@ -276,7 +276,7 @@ 
 		 * Returns the number of decimal places on string representing a price.
 		 *
 		 * @param string $number Price to check.
-		 * @return number number of decimal places.
+		 * @return null|integer number of decimal places.
 		 */
 		private function get_decimal_places( $number ) {
 			$parts = explode( '.', $number );
@@ -377,8 +377,7 @@ 
 		/**
 		 * Gets the latests field value from either the old instance or the new instance.
 		 *
-		 * @param array $mixed Array of values for the new form instance.
-		 * @param array $mixed Array of values for the old form instance.
+		 * @param string $field
 		 * @return mixed $mixed Field value.
 		 */
 		private function get_latest_field_value( $new_instance, $old_instance, $field ) {
@@ -392,6 +391,7 @@ 
 		 * it returns the default values.
 		 *
 		 * @param int Product Post ID.
+		 * @param integer $product_post_id
 		 * @return array $fields Product Fields from the Product Post.
 		 */
 		private function get_product_from_post( $product_post_id ) {

modules/wordads/php/api.php

Doc Comments +4 added lines, -4 removed lines

@@ -68,7 +68,7 @@ 
 	/**
 	 * Returns status of WordAds approval.
 	 *
-	 * @return boolean true if site is WordAds approved
+	 * @return string true if site is WordAds approved
 	 *
 	 * @since 4.5.0
 	 */
@@ -83,7 +83,7 @@ 
 	/**
 	 * Returns status of WordAds active.
 	 *
-	 * @return boolean true if ads are active on site
+	 * @return string true if ads are active on site
 	 *
 	 * @since 4.5.0
 	 */
@@ -98,7 +98,7 @@ 
 	/**
 	 * Returns status of WordAds house ads.
 	 *
-	 * @return boolean true if WP.com house ads should be shown
+	 * @return string true if WP.com house ads should be shown
 	 *
 	 * @since 4.5.0
 	 */
@@ -114,7 +114,7 @@ 
 	/**
 	 * Returns whether or not this site is safe to run ads on.
 	 *
-	 * @return boolean true if ads shown not be shown on this site.
+	 * @return string true if ads shown not be shown on this site.
 	 *
 	 * @since 6.5.0
 	 */

modules/wordads/wordads.php

Doc Comments +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
 	 * Convenience function for grabbing options from params->options
 	 *
 	 * @param  string $option the option to grab
-	 * @param  mixed  $default (optional)
+	 * @param  boolean  $default (optional)
 	 * @return option or $default if not set
 	 *
 	 * @since 4.5.0
@@ -494,7 +494,7 @@ 
 	/**
 	 * Check the reasons to bail before we attempt to insert ads.
 	 *
-	 * @return true if we should bail (don't insert ads)
+	 * @return boolean if we should bail (don't insert ads)
 	 *
 	 * @since 4.5.0
 	 */

_inc/lib/class.jetpack-keyring-service-helper.php

Doc Comments +8 added lines

@@ -100,6 +100,10 @@ 
 		), menu_page_url( 'sharing', false ) );
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $for
+	 */
 	static function refresh_url( $service_name, $for ) {
 		return add_query_arg( array(
 			'action'   => 'request',
@@ -111,6 +115,10 @@ 
 		), admin_url( 'options-general.php?page=sharing' ) );
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $id
+	 */
 	static function disconnect_url( $service_name, $id ) {
 		return add_query_arg( array(
 			'action'   => 'delete',