Changeset 52299

Timestamp:

12/01/2021 12:15:21 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections.

See #53399

Location:

trunk/src

Files:

• wp-admin/includes/image.php (modified) (1 diff)
• wp-admin/includes/post.php (modified) (1 diff)
• wp-includes/class-wp-block.php (modified) (1 diff)
• wp-includes/class-wp-http-proxy.php (modified) (2 diffs)
• wp-includes/class-wp-query.php (modified) (2 diffs)
• wp-includes/comment.php (modified) (1 diff)
• wp-includes/media.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (1 diff)
• wp-includes/pomo/entry.php (modified) (1 diff)
• wp-includes/taxonomy.php (modified) (1 diff)

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

@@ -688 +688 @@
  * @since 2.5.0
  *
- * @param string $str
- * @return int
+ * @param string $str A date string expected to be in Exif format (Y:m:d H:i:s).
+ * @return int|false The unix timestamp, or false on failure.
  */
 function wp_exif_date2ts( $str ) {

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

@@ -210 +210 @@
  * @since 5.0.1
  *
- * @param array|null $post_data Optional. The array of post data to process.
- *                              Defaults to the `$_POST` superglobal.
+ * @param array|WP_Error|null $post_data The array of post data to process, or an error object.
+ *                                       Defaults to the `$_POST` superglobal.
  * @return array|WP_Error Array of post data on success, WP_Error on failure.
  */

trunk/src/wp-includes/class-wp-block.php

@@ -197 +197 @@
      *
      * @param array $options {
-     *   Optional options object.
-     *
-     *   @type bool $dynamic Defaults to 'true'. Optionally set to false to avoid using the block's render_callback.
+     *     Optional options object.
+     *
+     *     @type bool $dynamic Defaults to 'true'. Optionally set to false to avoid using the block's render_callback.
      * }
      * @return string Rendered block output.

trunk/src/wp-includes/class-wp-http-proxy.php

@@ -45 +45 @@
      * Whether proxy connection should be used.
      *
-     * @since 2.8.0
-     *
-     * @use WP_PROXY_HOST
-     * @use WP_PROXY_PORT
+     * Constants which control this behaviour:
+     *
+     * - `WP_PROXY_HOST`
+     * - `WP_PROXY_PORT`
+     *
+     * @since 2.8.0
      *
      * @return bool
@@ -59 +61 @@
      * Whether authentication should be used.
      *
-     * @since 2.8.0
-     *
-     * @use WP_PROXY_USERNAME
-     * @use WP_PROXY_PASSWORD
+     * Constants which control this behaviour:
+     *
+     * - `WP_PROXY_USERNAME`
+     * - `WP_PROXY_PASSWORD`
+     *
+     * @since 2.8.0
      *
      * @return bool

trunk/src/wp-includes/class-wp-query.php

@@ -2827 +2827 @@
              *
              * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT,
-             * fields (SELECT), and LIMITS clauses.
+             * fields (SELECT), and LIMIT clauses.
              *
              * @since 3.1.0
@@ -2951 +2951 @@
              *
              * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT,
-             * fields (SELECT), and LIMITS clauses.
+             * fields (SELECT), and LIMIT clauses.
              *
              * @since 3.1.0

trunk/src/wp-includes/comment.php

@@ -367 +367 @@
  * @param int $post_id Optional. Restrict the comment counts to the given post. Default 0, which indicates that
  *                     comment counts for the whole site will be retrieved.
- * @return array() {
+ * @return array {
  *     The number of comments keyed by their status.
  *

trunk/src/wp-includes/media.php

@@ -4225 +4225 @@
  *     Arguments for enqueuing media scripts.
  *
- *     @type int|WP_Post A post object or ID.
+ *     @type int|WP_Post $post A post object or ID.
  * }
  */

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

@@ -1308 +1308 @@
  * a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events
  * that should affect all new users, but only on Multisite (otherwise
- * use {@see'user_register'}).
+ * use {@see 'user_register'}).
  *
  * @since MU (3.0.0)

trunk/src/wp-includes/pomo/entry.php

@@ -17 +17 @@
          * Whether the entry contains a string and its plural form, default is false
          *
-         * @var boolean
+         * @var bool
          */
         public $is_plural = false;

trunk/src/wp-includes/taxonomy.php

@@ -4637 +4637 @@
  *     supported by get_the_taxonomies(), in addition to the following.
  *
- *     @type  int|WP_Post $post   Post ID or object to get taxonomies of. Default current post.
- *     @type  string      $before Displays before the taxonomies. Default empty string.
- *     @type  string      $sep    Separates each taxonomy. Default is a space.
- *     @type  string      $after  Displays after the taxonomies. Default empty string.
+ *     @type int|WP_Post $post   Post ID or object to get taxonomies of. Default current post.
+ *     @type string      $before Displays before the taxonomies. Default empty string.
+ *     @type string      $sep    Separates each taxonomy. Default is a space.
+ *     @type string      $after  Displays after the taxonomies. Default empty string.
  * }
  */