Changeset 53229

Timestamp:

04/20/2022 08:28:00 AM (3 years ago)

Author:

audrasjb

Message:

Docs: Misc fixes and improvements in the Administration Media API docblocks, as per documentation standards.

See #54729.

File:

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

trunk/src/wp-admin/includes/media.php

@@ -8 +8 @@
 
 /**
- * Defines the default media upload tabs
+ * Defines the default media upload tabs.
  *
  * @since 2.5.0
@@ -33 +33 @@
 
 /**
- * Adds the gallery tab back to the tabs array if post has image attachments
+ * Adds the gallery tab back to the tabs array if post has image attachments.
  *
  * @since 2.5.0
@@ -613 +613 @@
 
 /**
- * Adds the media button to the editor
+ * Adds the media button to the editor.
  *
  * @since 2.5.0
@@ -1117 +1117 @@
 
 /**
- * Retrieve HTML for the image alignment radio buttons with the specified one checked.
+ * Retrieves HTML for the image alignment radio buttons with the specified one checked.
  *
  * @since 2.7.0
@@ -1155 +1155 @@
 
 /**
- * Retrieve HTML for the size radio buttons with the specified one checked.
+ * Retrieves HTML for the size radio buttons with the specified one checked.
  *
  * @since 2.7.0
@@ -1233 +1233 @@
 
 /**
- * Retrieve HTML for the Link URL buttons with the default link type as specified.
+ * Retrieves HTML for the Link URL buttons with the default link type as specified.
  *
  * @since 2.7.0
@@ -1267 +1267 @@
 
 /**
- * Output a textarea element for inputting an attachment caption.
+ * Outputs a textarea element for inputting an attachment caption.
  *
  * @since 3.4.0
@@ -1487 +1487 @@
 
 /**
- * Retrieve HTML for media items of post gallery.
+ * Retrieves HTML for media items of post gallery.
  *
  * The HTML markup retrieved will be created for the progress of SWF Upload
@@ -1499 +1499 @@
  * @param int   $post_id Post ID.
  * @param array $errors  Errors for attachment, if any.
- * @return string
+ * @return string HTML content for media items of post gallery.
  */
 function get_media_items( $post_id, $errors ) {
@@ -1544 +1544 @@
 
 /**
- * Retrieve HTML form for modifying the image attachment.
+ * Retrieves HTML form for modifying the image attachment.
  *
  * @since 2.5.0
@@ -2504 +2504 @@
 
 /**
- * Adds gallery form to upload iframe
+ * Adds gallery form to upload iframe.
  *
  * @since 2.5.0
@@ -2878 +2878 @@
 
 /**
- * Creates the form for external url
+ * Creates the form for external url.
  *
  * @since 2.7.0
  *
  * @param string $default_view
- * @return string the form html
+ * @return string HTML content of the form.
  */
 function wp_media_insert_url_form( $default_view = 'image' ) {
@@ -3467 +3467 @@
 
 /**
- * Parse ID3v2, ID3v1, and getID3 comments to extract usable data
+ * Parses ID3v2, ID3v1, and getID3 comments to extract usable data.
  *
  * @since 3.6.0
  *
- * @param array $metadata An existing array with data
- * @param array $data Data supplied by ID3 tags
+ * @param array $metadata An existing array with data.
+ * @param array $data Data supplied by ID3 tags.
  */
 function wp_add_id3_tag_data( &$metadata, $data ) {
@@ -3512 +3512 @@
 
 /**
- * Retrieve metadata from a video file's ID3 tags
+ * Retrieves metadata from a video file's ID3 tags.
  *
  * @since 3.6.0
@@ -3626 +3626 @@
 
 /**
- * Retrieve metadata from an audio file's ID3 tags.
+ * Retrieves metadata from an audio file's ID3 tags.
  *
  * @since 3.6.0
@@ -3693 +3693 @@
 
 /**
- * Parse creation date from media metadata.
+ * Parses creation date from media metadata.
  *
  * The getID3 library doesn't have a standard method for getting creation dates,