Changeset 32042

Timestamp:

04/05/2015 04:03:12 PM (8 years ago)

Author:

DrewAPicture

Message:

Various inline documentation syntax fixes in wp-includes/link-template.php.

See #31888.

File:

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

trunk/src/wp-includes/link-template.php

@@ -3391 +3391 @@
  * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
  *                           user email, WP_User object, WP_Post object, or comment object.
- * @param array $args        {
+ * @param array $args {
  *     Optional. Arguments to return instead of the default arguments.
  *
@@ -3404 +3404 @@
  *     @type string $rating         What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
  *                                  judged in that order. Default is the value of the 'avatar_rating' option.
- *     @type string $scheme         URL scheme to use. See {@see set_url_scheme()} for accepted values.
+ *     @type string $scheme         URL scheme to use. See set_url_scheme() for accepted values.
  *                                  Default null.
  *     @type array  $processed_args When the function returns, the value will be the processed/sanitized $args
  *                                  plus a "found_avatar" guess. Pass as a reference. Default null.
  * }
- *
  * @return false|string The URL of the avatar we found, or false if we couldn't find an avatar.
  */
@@ -3424 +3423 @@
  * @param mixed $id_or_email The Gravatar to check the data against. Accepts a user_id, gravatar md5 hash,
  *                           user email, WP_User object, WP_Post object, or comment object.
- * @param array $args        {
+ * @param array $args {
  *     Optional. Arguments to return instead of the default arguments.
  *
@@ -3439 +3438 @@
  *     @type string $rating         What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are
  *                                  judged in that order. Default is the value of the 'avatar_rating' option.
- *     @type string $scheme         URL scheme to use. See {@see set_url_scheme()} for accepted values.
+ *     @type string $scheme         URL scheme to use. See set_url_scheme() for accepted values.
  *                                  Default null.
  *     @type array  $processed_args When the function returns, the value will be the processed/sanitized $args
@@ -3445 +3444 @@
  *     @type string $extra_attr     HTML attributes to insert in the IMG element. Is not sanitized. Default empty.
  * }
- *
  * @return array $processed_args {
- *     Along with the arguments passed in $args, this will contain a couple of extra arguments.
+ *     Along with the arguments passed in `$args`, this will contain a couple of extra arguments.
  *
  *     @type bool   $found_avatar True if we were able to find an avatar for this user,
@@ -3519 +3517 @@
      *
      * Passing a non-null value in the 'url' member of the return array will
-     * effectively short circuit {@see get_avatar_data()}, passing the value
-     * through the 'get_avatar_data' filter and returning early.
+     * effectively short circuit get_avatar_data(), passing the value through
+     * the {@see 'get_avatar_data'} filter and returning early.
      *
      * @since 4.2.0
@@ -3615 +3613 @@
      * @since 4.2.0
      *
-     * @param string            $url           The URL of the avatar.
-     * @param int|object|string $id_or_email   A user ID, email address, or comment object.
-     * @param array             $args          Arguments passed to get_avatar_data(), after processing.
+     * @param string            $url         The URL of the avatar.
+     * @param int|object|string $id_or_email A user ID, email address, or comment object.
+     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
      */
     $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args );
@@ -3626 +3624 @@
      * @since 4.2.0
      *
-     * @param array             $args          Arguments passed to get_avatar_data(), after processing.
-     * @param int|object|string $id_or_email   A user ID, email address, or comment object.
+     * @param array             $args        Arguments passed to get_avatar_data(), after processing.
+     * @param int|object|string $id_or_email A user ID, email address, or comment object.
      */
     return apply_filters( 'get_avatar_data', $args, $id_or_email );