Changeset 28004 for trunk/src/wp-includes/media.php

Timestamp:

04/07/2014 08:37:17 PM (11 years ago)

Author:

DrewAPicture

Message:

General PHPDoc improvements in wp-includes/media.php for 3.9 functionality.

See #27700.

File:

• trunk/src/wp-includes/media.php (modified) (8 diffs)

trunk/src/wp-includes/media.php

@@ -1010 +1010 @@
 
 /**
- * Output the templates used by playlists
+ * Output the templates used by playlists.
  *
  * @since 3.9.0
@@ -1052 +1052 @@
  * @since 3.9.0
  *
- * @param string $type Type of playlist: "audio" or "video."
+ * @param string $type Type of playlist. Accepts 'audio' or 'video'.
  */
 function wp_playlist_scripts( $type ) {
@@ -1065 +1065 @@
 
 /**
- * The Playlist shortcode.
- *
- * This implements the functionality of the Playlist Shortcode for displaying
+ * The playlist shortcode.
+ *
+ * This implements the functionality of the playlist shortcode for displaying
  * a collection of WordPress audio or video files in a post.
  *
  * @since 3.9.0
  *
- * @param array  $attr Attributes of the shortcode.
+ * @param array $attr Playlist shortcode attributes.
  * @return string Playlist output. Empty string if the passed type is unsupported.
  */
@@ -1261 +1261 @@
          * @since 3.9.0
          *
-         * @param string $type   Type of playlist: "audio" or "video."
-         * @param string $style  The "theme" for the playlist. Core provides "light" and "dark."
+         * @param string $type  Type of playlist. Possible values are 'audio' or 'video'.
+         * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.
          */
         do_action( 'wp_playlist_scripts', $type, $style );
@@ -1318 +1318 @@
  * @since 3.9.0
  *
- * @param WP_Post $attachment The attachment in question, provided for context.
+ * @param WP_Post $attachment The current attachment, provided for context.
  * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.
- * @return array
+ * @return array Key/value pairs of field keys to labels.
  */
 function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
@@ -2735 +2735 @@
 
 /**
- * If an attachment is missing its metadata, try to generate it.
+ * Maybe attempt to generate attachment metadata, if missing.
  *
  * @since 3.9.0
  *
- * @param post $attachment Post object.
+ * @param WP_Post $attachment Attachment object.
  */
 function wp_maybe_generate_attachment_metadata( $attachment ) {
@@ -2760 +2760 @@
 
 /**
- * Determine if a post supports thumbnails based on the passed $post
+ * Determine if a post supports thumbnails based on the passed post object.
  *
  * @since 3.9.0
  *
- * @param WP_Post $post
- *
- * @return boolean
+ * @param WP_Post $post Post object.
+ *
+ * @return bool Whether the post type supports thumbnails.
  */
 function post_supports_thumbnails( $post ) {
@@ -2781 +2781 @@
 
 /**
- * Determine if a theme supports thumbnails based on the passed $post
+ * Determine if a theme supports thumbnails based on the passed post object.
  *
  * @since 3.9.0
  *
- * @param WP_Post $post
- *
- * @return boolean
+ * @param WP_Post $post Post object.
+ *
+ * @return bool Whether the current theme supports thumbnails.
  */
 function theme_supports_thumbnails( $post ) {