Automattic / jetpack

json-endpoints/class.wpcom-json-api-edit-media-v1-2-endpoint.php

Doc Comments +3 added lines, -3 removed lines

@@ -101,7 +101,7 @@ 
 	 * Update the media post grabbing the post values from
 	 * the `attrs` parameter
 	 *
-	 * @param  {Number} $media_id - post media ID
+	 * @param  integer $media_id - post media ID
 	 * @param  {Object} $attrs - `attrs` parameter sent from the client in the request body
 	 * @return
 	 */
@@ -202,7 +202,7 @@ 
 	 * Save the given temporal file in a local folder.
 	 *
 	 * @param  {Array} $file_array
-	 * @param  {Number} $media_id
+	 * @param  integer $media_id
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */
 	private function save_temporary_file( $file_array, $media_id ) {
@@ -277,7 +277,7 @@ 
 	/**
 	 * Get the image from a remote url and then save it locally.
 	 *
-	 * @param  {Number} $media_id - media post ID
+	 * @param  integer $media_id - media post ID
 	 * @param  {String} $url - image URL to save locally
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */

modules/sharedaddy/sharing-service.php

Doc Comments +3 added lines

@@ -505,6 +505,9 @@
 	public $service = '';
 	public $total   = 0;
 
+	/**
+	 * @param integer $total
+	 */
 	public function __construct( $id, $total ) {
 		$services      = new Sharing_Service();
 		$this->id      = esc_html( $id );

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

modules/post-by-email.php

Doc Comments +1 added lines, -1 removed lines

@@ -175,7 +175,7 @@
 	/**
 	 * Back end function to abstract the xmlrpc function calls to wpcom.
 	 *
-	 * @param $endpoint
+	 * @param string $endpoint
 	 * @param $error_message
 	 */
 	function __process_ajax_proxy_request( $endpoint, $error_message ) { // phpcs:ignore

_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/photon-cdn.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
 	 *
 	 * @param String $plugin_slug plugin slug string.
 	 * @param String $current_version plugin version string.
-	 * @return null|bool
+	 * @return false|null
 	 */
 	public static function cdnize_plugin_assets( $plugin_slug, $current_version ) {
 		global $wp_scripts, $wp_styles;

modules/shortcodes/class.filter-embedded-html-objects.php

Doc Comments +6 added lines

@@ -112,6 +112,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $regexp
+	 */
 	public static function regexp_entities( $regexp ) {
 		return preg_replace(
 			'/\[\^&([^\]]+)\]\*\+/',
@@ -150,6 +153,9 @@ 
 		return self::dispatch( $matches );
 	}
 
+	/**
+	 * @param string[] $matches
+	 */
 	static function dispatch( $matches ) {
 		$html  = preg_replace( '%&#0*58;//%', '://', $matches[0] );
 		$attrs = self::get_attrs( $html );

modules/widgets/goodreads.php

Doc Comments +3 added lines

@@ -90,6 +90,9 @@
 		echo $args['after_widget'];
 	}
 
+	/**
+	 * @param string $user_id
+	 */
 	function goodreads_user_id_exists( $user_id ) {
 		$url      = "https://www.goodreads.com/user/show/$user_id/";
 		$response = wp_remote_head(

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 ) {