Changeset 59896

Timestamp:

03/02/2025 12:41:48 AM (3 months ago)

Author:

johnbillion

Message:

Docs: Various improvements to inline documentation.

See #62281

Location:

trunk

Files:

• src/wp-admin/includes/misc.php (modified) (1 diff)
• src/wp-admin/includes/post.php (modified) (3 diffs)
• src/wp-admin/includes/user.php (modified) (1 diff)
• src/wp-includes/script-loader.php (modified) (4 diffs)
• src/wp-includes/update.php (modified) (1 diff)
• tests/phpunit/includes/abstract-testcase.php (modified) (2 diffs)

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

@@ -626 +626 @@
  *
  * @param string $content
- * @return array
+ * @return string[] Array of function names.
  */
 function wp_doc_link_parse( $content ) {

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

@@ -494 +494 @@
  * @param array|null $post_data Optional. The array of post data to process.
  *                              Defaults to the `$_POST` superglobal.
- * @return array
+ * @return array {
+ *     An array of updated, skipped, and locked post IDs.
+ *
+ *     @type int[] $updated An array of updated post IDs.
+ *     @type int[] $skipped An array of skipped post IDs.
+ *     @type int[] $locked  An array of locked post IDs.
+ * }
  */
 function bulk_edit_posts( $post_data = null ) {
@@ -1212 +1218 @@
  * @param array|false $q Optional. Array of query variables to use to build the query.
  *                       Defaults to the `$_GET` superglobal.
- * @return array
+ * @return string[] An array of all the statuses for the queried post type.
  */
 function wp_edit_posts_query( $q = false ) {
@@ -1384 +1390 @@
  * @param array|false $q Optional. Array of query variables to use to build the query.
  *                       Defaults to the `$_GET` superglobal.
- * @return array
+ * @return array {
+ *     Array containing the post mime types and available post mime types.
+ *
+ *     @type array[]  $post_mime_types       Post mime types.
+ *     @type string[] $avail_post_mime_types Available post mime types.
+ * }
  */
 function wp_edit_attachments_query( $q = false ) {

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

@@ -314 +314 @@
 
     /**
-     * Filters the user's drafts query string.
+     * Filters the SQL query string for the user's drafts query.
      *
      * @since 2.0.0

trunk/src/wp-includes/script-loader.php

@@ -2096 +2096 @@
  * @global bool $concatenate_scripts
  *
- * @return array
+ * @return string[] Handles of the scripts that were printed.
  */
 function print_head_scripts() {
@@ -2135 +2135 @@
  * @global bool       $concatenate_scripts
  *
- * @return array
+ * @return string[] Handles of the scripts that were printed.
  */
 function print_footer_scripts() {
@@ -2216 +2216 @@
  * @global WP_Scripts $wp_scripts
  *
- * @return array
+ * @return string[] Handles of the scripts that were printed.
  */
 function wp_print_head_scripts() {
@@ -2281 +2281 @@
  * @global bool $concatenate_scripts
  *
- * @return array
+ * @return string[] Handles of the styles that were printed.
  */
 function print_admin_styles() {

trunk/src/wp-includes/update.php

@@ -892 +892 @@
  * @since 3.3.0
  *
- * @return array
+ * @return array {
+ *     Fetched update data.
+ *
+ *     @type int[]   $counts       An array of counts for available plugin, theme, and WordPress updates.
+ *     @type string  $update_title Titles of available updates.
+ * }
  */
 function wp_get_update_data() {

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -1463 +1463 @@
      *
      * @param string $dir Path to the directory to scan.
-     * @return array List of file paths.
+     * @return string[] List of file paths.
      */
     public function files_in_dir( $dir ) {
@@ -1484 +1484 @@
      * @since 4.0.0
      *
-     * @return array List of file paths.
+     * @return string[] List of file paths.
      */
     public function scan_user_uploads() {