Docs: First pass at some inline docs fixes mostly made by PHPCBF.

See #49572, #50744
Built from https://develop.svn.wordpress.org/trunk@48586


git-svn-id: http://core.svn.wordpress.org/trunk@48348 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-admin/includes/class-wp-ms-sites-list-table.php

@@ -213,7 +213,6 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
 	 * @since 5.3.0
 	 *
 	 * @return array
-	 *
 	 */
 	protected function get_views() {
 		$counts = wp_count_sites();

wp-admin/includes/class-wp-site-health-auto-updates.php

@@ -10,6 +10,7 @@
 class WP_Site_Health_Auto_Updates {
 	/**
 	 * WP_Site_Health_Auto_Updates constructor.
+	 *
 	 * @since 5.2.0
 	 */
 	public function __construct() {

wp-admin/includes/class-wp-terms-list-table.php

@@ -601,7 +601,7 @@ class WP_Terms_List_Table extends WP_List_Table {
 
 	/**
 	 * @param WP_Term $tag         Term object.
-	 * @param string $column_name
+	 * @param string  $column_name Name of the column.
 	 * @return string
 	 */
 	public function column_default( $tag, $column_name ) {

wp-admin/includes/nav-menu.php

@@ -1136,8 +1136,8 @@ function _wp_delete_orphaned_draft_menu_items() {
  *
  * @since 3.6.0
  *
- * @param int|string $nav_menu_selected_id (id, slug, or name ) of the currently-selected menu
- * @param string $nav_menu_selected_title Title of the currently-selected menu
+ * @param int|string $nav_menu_selected_id    ID, slug, or name of the currently-selected menu.
+ * @param string     $nav_menu_selected_title Title of the currently-selected menu.
  * @return array The menu updated message
  */
 function wp_nav_menu_update_menu_items( $nav_menu_selected_id, $nav_menu_selected_title ) {

wp-admin/includes/privacy-tools.php

@@ -719,6 +719,7 @@ All at ###SITENAME###
 
 /**
  * Intercept personal data exporter page Ajax responses in order to assemble the personal data export file.
+ *
  * @see wp_privacy_personal_data_export_page
  * @since 4.9.6
  *

wp-includes/bookmark.php

@@ -14,8 +14,9 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|stdClass $bookmark
- * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
- *                       an stdClass object, an associative array, or a numeric array, respectively. Default OBJECT.
+ * @param string       $output   Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond
+ *                               to an stdClass object, an associative array, or a numeric array, respectively.
+ *                               Default OBJECT.
  * @param string       $filter   Optional. How to sanitize bookmark fields. Default 'raw'.
  * @return array|object|null Type returned depends on $output value.
  */
@@ -68,8 +69,8 @@ function get_bookmark( $bookmark, $output = OBJECT, $filter = 'raw' ) {
  *
  * @since 2.3.0
  *
- * @param string $field The name of the data field to return
- * @param int $bookmark The bookmark ID to get field
+ * @param string $field    The name of the data field to return.
+ * @param int    $bookmark The bookmark ID to get field.
  * @param string $context  Optional. The context of how the field will be used.
  * @return string|WP_Error
  */

wp-includes/category-template.php

@@ -238,9 +238,10 @@ function get_the_category_list( $separator = '', $parents = '', $post_id = false
  * Conditional Tags} article in the Theme Developer Handbook.
  *
  * @since 1.2.0
+ * @since 2.7.0 The `$post` parameter was added.
  *
  * @param int|string|array $category Category ID, name or slug, or array of said.
- * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
+ * @param int|object       $post     Optional. Post to check instead of the current post.
  * @return bool True if the current post is in any of the given categories.
  */
 function in_category( $category, $post = null ) {
@@ -1161,9 +1162,9 @@ function get_the_tags( $id = 0 ) {
  *
  * @since 2.3.0
  *
- * @param string $before Optional. Before tags.
- * @param string $sep Optional. Between tags.
- * @param string $after Optional. After tags.
+ * @param string $before Optional. String to use before tags.
+ * @param string $sep    Optional. String to use between the tags.
+ * @param string $after  Optional. String to use after tags.
  * @param int    $id     Optional. Post ID. Defaults to the current post.
  * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
  */

wp-includes/class-http.php

@@ -510,7 +510,7 @@ class WP_Http {
 	 * @since 3.2.0
 	 *
 	 * @param array  $args Request arguments.
-	 * @param string $url URL to Request.
+	 * @param string $url  URL to request.
 	 * @return string|false Class name for the first transport that claims to support the request.
 	 *                      False if no transport claims to support the request.
 	 */
@@ -559,7 +559,7 @@ class WP_Http {
 	 * @deprecated 5.1.0 Use WP_Http::request()
 	 * @see WP_Http::request()
 	 *
-	 * @param string $url URL to Request.
+	 * @param string $url  URL to request.
 	 * @param array  $args Request arguments.
 	 * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
 	 *                        A WP_Error instance upon error.

wp-includes/class-wp-date-query.php

@@ -797,8 +797,8 @@ class WP_Date_Query {
 	 *
 	 * @since 3.7.0
 	 *
-	 * @param string $compare The compare operator to use
-	 * @param string|array $value The value
+	 * @param string       $compare The compare operator to use.
+	 * @param string|array $value   The value.
 	 * @return string|false|int The value to be used in SQL or false on error.
 	 */
 	public function build_value( $compare, $value ) {

wp-includes/class-wp-editor.php

@@ -1449,7 +1449,8 @@ final class _WP_Editors {
 	 * @since 3.9.0
 	 *
 	 * @param string $mce_locale The locale used for the editor.
-	 * @param bool $json_only optional Whether to include the JavaScript calls to tinymce.addI18n() and tinymce.ScriptLoader.markDone().
+	 * @param bool   $json_only  Optional. Whether to include the JavaScript calls to tinymce.addI18n() and
+	 *                           tinymce.ScriptLoader.markDone().
 	 * @return string Translation object, JSON encoded.
 	 */
 	public static function wp_mce_translation( $mce_locale = '', $json_only = false ) {

wp-includes/class-wp-error.php

@@ -47,8 +47,8 @@ class WP_Error {
 	 *
 	 * @since 2.1.0
 	 *
-	 * @param string|int $code Error code
-	 * @param string $message Error message
+	 * @param string|int $code    Error code.
+	 * @param string     $message Error message.
 	 * @param mixed      $data    Optional. Error data.
 	 */
 	public function __construct( $code = '', $message = '', $data = '' ) {

wp-includes/class-wp-term-query.php

@@ -697,7 +697,6 @@ class WP_Term_Query {
 		 * @param array|null    $terms Return an array of term data to short-circuit WP's term query,
 		 *                             or null to allow WP queries to run normally.
 		 * @param WP_Term_Query $this  The WP_Term_Query instance, passed by reference.
-		 *
 		 */
 		$this->terms = apply_filters_ref_array( 'terms_pre_query', array( $this->terms, &$this ) );
 

wp-includes/version.php

@@ -13,7 +13,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '5.5-beta3-48585';
+$wp_version = '5.5-beta3-48586';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.