Automattic / jetpack

_inc/lib/class.media.php

Doc Comments +7 added lines, -3 removed lines

@@ -84,7 +84,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(
@@ -252,7 +252,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 ) {
@@ -280,6 +280,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
@@ -295,7 +298,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 );
@@ -365,6 +368,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) {