Automattic / jetpack

_inc/lib/class.media.php

Doc Comments +6 added lines, -3 removed lines

@@ -87,7 +87,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(
@@ -254,7 +254,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 ) {
@@ -282,6 +282,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
@@ -297,7 +300,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 );

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

Doc Comments +2 added lines, -2 removed lines

@@ -7,7 +7,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 bool|WP_Error `WP_Error` on failure. `true` on success.
 	 */
@@ -64,7 +64,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/masterbar/masterbar.php

Doc Comments +6 added lines

@@ -80,6 +80,9 @@ 
 		wp_enqueue_script( 'a8c_wpcom_masterbar_overrides', $this->wpcom_static_url( '/wp-content/mu-plugins/admin-bar/masterbar-overrides/masterbar.js' ) );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	function wpcom_static_url( $file ) {
 		$i   = hexdec( substr( md5( $file ), - 1 ) ) % 2;
 		$url = 'https://s' . $i . '.wp.com' . $file;
@@ -255,6 +258,9 @@ 
 		return $primary_anchor . $secondary_anchor;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function create_menu_item_anchor( $class, $url, $label, $id ) {
 		return '<a href="' . $url . '" class="' . $class . '" id="' . $id . '">' . $label . '</a>';
 	}