From a752c42b05438f6227f4d81b92bf2dea3821be65 Mon Sep 17 00:00:00 2001
From: "Drew Jaynes (DrewAPicture)" <drewapicture@git.wordpress.org>
Date: Mon, 14 Jul 2014 01:06:58 +0000
Subject: [PATCH] Inline documentation cleanup for 4.0 audit.

Added in [28652]:
* Various phpDoc improvements for `wp_embed_handler_youtube()`
* Adds `@see` reference to `wp_embed_handler_youtube()` in 'wp_embed_handler_youtube' filter docs

Added in [29029]:
* s/post_id/post ID in `@return` description for `attachment_url_to_postid()`

See #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29164 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/media.php | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/wp-includes/media.php b/src/wp-includes/media.php
index f8c950b314..c327008410 100644
--- a/src/wp-includes/media.php
+++ b/src/wp-includes/media.php
@@ -2281,14 +2281,17 @@ function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
 }
 
 /**
- * The YouTube embed handler callback. Catches URLs that can be parsed but aren't supported by oEmbed.
+ * YouTube embed handler callback.
+ *
+ * Catches URLs that can be parsed but aren't supported by oEmbed.
  *
  * @since 4.0.0
  *
- * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
- * @param array $attr Embed attributes.
- * @param string $url The original URL that was matched by the regex.
- * @param array $rawattr The original unmodified attributes.
+ * @param array  $matches The regex matches from the provided regex when calling
+ *                        {@link wp_embed_register_handler()}.
+ * @param array  $attr    Embed attributes.
+ * @param string $url     The original URL that was matched by the regex.
+ * @param array  $rawattr The original unmodified attributes.
  * @return string The embed HTML.
  */
 function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
@@ -2299,6 +2302,8 @@ function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
 	 *
 	 * @since 4.0.0
 	 *
+	 * @see wp_embed_handler_youtube()
+	 *
 	 * @param string $embed   YouTube embed output.
 	 * @param array  $attr    An array of embed attributes.
 	 * @param string $url     The original URL that was matched by the regex.
@@ -3232,8 +3237,9 @@ function wp_maybe_generate_attachment_metadata( $attachment ) {
  * @since 4.0.0
  *
  * @global wpdb $wpdb WordPress database access abstraction object.
+ *
  * @param string $url The URL to resolve.
- * @return int The found post_id.
+ * @return int The found post ID.
  */
 function attachment_url_to_postid( $url ) {
 	global $wpdb;