Changeset 39639

Timestamp:

12/27/2016 09:27:38 AM (8 years ago)

Author:

johnbillion

Message:

Docs: Misc corrections and additions to inline documentation.

See #39130
Props keesiemeijer

Location:

trunk/src/wp-includes

Files:

• category-template.php (modified) (1 diff)
• functions.php (modified) (1 diff)
• general-template.php (modified) (1 diff)
• link-template.php (modified) (2 diffs)
• media-template.php (modified) (1 diff)
• ms-functions.php (modified) (1 diff)
• pluggable.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-settings-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-users-controller.php (modified) (3 diffs)
• taxonomy.php (modified) (1 diff)

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

@@ -719 +719 @@
 
 /**
- * Default topic count scaling for tag links
+ * Default topic count scaling for tag links.
  *
  * @since 2.9.0

trunk/src/wp-includes/functions.php

@@ -5393 +5393 @@
      * @since 2.1.0
      *
-     * @param string $medium Path to the file to delete.
+     * @param string $file Path to the file to delete.
      */
     $delete = apply_filters( 'wp_delete_file', $file );

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

@@ -3546 +3546 @@
      *
      * @since 2.3.0
-     *
-     * @param string $file Style handle name or filename (without ".css" extension)
-     *                     relative to wp-admin/. Defaults to 'wp-admin'.
+     * @param string $stylesheet_link HTML link element for the stylesheet.
+     * @param string $file            Style handle name or filename (without ".css" extension)
+     *                                relative to wp-admin/. Defaults to 'wp-admin'.
      */
     echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( $file ) ) . "' type='text/css' />\n", $file );

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

@@ -847 +847 @@
          * @param string $link The taxonomy feed link.
          * @param string $feed Feed type.
-         * @param string $feed The taxonomy name.
+         * @param string $taxonomy The taxonomy name.
          */
         $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy );
@@ -3584 +3584 @@
      * @since 4.6.0
      *
-     * @param string  $string The post's canonical URL.
-     * @param WP_Post $post   Post object.
+     * @param string  $canonical_url The post's canonical URL.
+     * @param WP_Post $post          Post object.
      */
     return apply_filters( 'get_canonical_url', $canonical_url, $post );

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

@@ -762 +762 @@
                 >
                 <?php
-                // This filter is documented in wp-admin/includes/media.php
+                /** This filter is documented in wp-admin/includes/media.php */
                 $size_names = apply_filters( 'image_size_names_choose', array(
                     'thumbnail' => __( 'Thumbnail' ),

trunk/src/wp-includes/ms-functions.php

@@ -2241 +2241 @@
 
 /**
- *  Update the network-wide counts for the current network.
+ * Update the network-wide counts for the current network.
  *
  * @since 3.1.0

trunk/src/wp-includes/pluggable.php

@@ -2413 +2413 @@
      *                            user email, WP_User object, WP_Post object, or WP_Comment object.
      * @param int    $size        Square avatar width and height in pixels to retrieve.
-     * @param string $alt         Alternative text to use in the avatar image tag.
-     *                                       Default empty.
+     * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
+     *                            'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'.
+     *                            Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
+     * @param string $alt         Alternative text to use in the avatar image tag. Default empty.
      * @param array  $args        Arguments passed to get_avatar_data(), after processing.
      */

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -1594 +1594 @@
      *
      * @since 4.7.0
+     * @access public
      *
      * @param string          $value   Author email value submitted.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1167 +1167 @@
      *
      * @since 4.7.0
+     * @access protected
      *
      * @param WP_REST_Request $request The request object with post and terms data.
@@ -1520 +1521 @@
      *
      * @since 4.7.0
+     * @access public
      *
      * @return string Protected title format.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

@@ -307 +307 @@
      *
      * @since 4.7.0
+     * @access public
      *
      * @param  mixed           $value   The value for the setting.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -143 +143 @@
      *
      * @since 4.7.0
+     * @access public
      *
      * @param int|bool        $value   The value passed to the reassign parameter.
@@ -1055 +1056 @@
      *
      * @since 4.7.0
+     * @access public
      *
      * @param  mixed            $value   The username submitted in the request.
@@ -1084 +1086 @@
      *
      * @since 4.7.0
+     * @access public
      *
      * @param  mixed            $value   The password submitted in the request.

trunk/src/wp-includes/taxonomy.php

@@ -2944 +2944 @@
      *
      * @param array  $object_ids An array of object IDs.
-     * @param string $objet_type Object type.
+     * @param string $object_type Object type.
      */
     do_action( 'clean_object_term_cache', $object_ids, $object_type );