Changeset 51955

Timestamp:

10/29/2021 11:11:32 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock improvements.

See #53399

Location:

trunk/src

Files:

• wp-admin/includes/plugin.php (modified) (16 diffs)
• wp-admin/includes/upgrade.php (modified) (1 diff)
• wp-includes/cron.php (modified) (2 diffs)
• wp-includes/formatting.php (modified) (1 diff)
• wp-includes/theme.php (modified) (1 diff)
• wp-login.php (modified) (1 diff)

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

@@ -1279 +1279 @@
 
 /**
- * Add a top-level menu page.
+ * Adds a top-level menu page.
  *
  * This function takes a capability which will be used to determine whether
@@ -1351 +1351 @@
 
 /**
- * Add a submenu page.
+ * Adds a submenu page.
  *
  * This function takes a capability which will be used to determine whether
@@ -1475 +1475 @@
 
 /**
- * Add submenu page to the Tools main menu.
+ * Adds a submenu page to the Tools main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1499 +1499 @@
 
 /**
- * Add submenu page to the Settings main menu.
+ * Adds a submenu page to the Settings main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1523 +1523 @@
 
 /**
- * Add submenu page to the Appearance main menu.
+ * Adds a submenu page to the Appearance main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1547 +1547 @@
 
 /**
- * Add submenu page to the Plugins main menu.
+ * Adds a submenu page to the Plugins main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1571 +1571 @@
 
 /**
- * Add submenu page to the Users/Profile main menu.
+ * Adds a submenu page to the Users/Profile main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1600 +1600 @@
 
 /**
- * Add submenu page to the Dashboard main menu.
+ * Adds a submenu page to the Dashboard main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1624 +1624 @@
 
 /**
- * Add submenu page to the Posts main menu.
+ * Adds a submenu page to the Posts main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1648 +1648 @@
 
 /**
- * Add submenu page to the Media main menu.
+ * Adds a submenu page to the Media main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1672 +1672 @@
 
 /**
- * Add submenu page to the Links main menu.
+ * Adds a submenu page to the Links main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1696 +1696 @@
 
 /**
- * Add submenu page to the Pages main menu.
+ * Adds a submenu page to the Pages main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1720 +1720 @@
 
 /**
- * Add submenu page to the Comments main menu.
+ * Adds a submenu page to the Comments main menu.
  *
  * This function takes a capability which will be used to determine whether
@@ -1744 +1744 @@
 
 /**
- * Remove a top-level admin menu.
+ * Removes a top-level admin menu.
+ *
+ * Example usage:
+ *
+ *  - `remove_menu_page( 'tools.php' )`
+ *  - `remove_menu_page( 'plugin_menu_slug' )`
  *
  * @since 3.1.0
@@ -1767 +1772 @@
 
 /**
- * Remove an admin submenu.
+ * Removes an admin submenu.
+ *
+ * Example usage:
+ *
+ *  - `remove_submenu_page( 'themes.php', 'nav-menus.php' )`
+ *  - `remove_submenu_page( 'tools.php', 'plugin_submenu_slug' )`
+ *  - `remove_submenu_page( 'plugin_menu_slug', 'plugin_submenu_slug' )`
  *
  * @since 3.1.0
@@ -1795 +1806 @@
 
 /**
- * Get the URL to access a particular menu page based on the slug it was registered with.
+ * Gets the URL to access a particular menu page based on the slug it was registered with.
  *
  * If the slug hasn't been registered properly, no URL will be returned.

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

@@ -1879 +1879 @@
  * @ignore
  * @since 3.7.2
- * @since 3.8.0
  *
  * @global int $wp_current_db_version The old (current) database version.

trunk/src/wp-includes/cron.php

@@ -1041 +1041 @@
  * @since 5.4.0 The 'weekly' schedule was added.
  *
- * @return array
+ * @return array[]
  */
 function wp_get_schedules() {
@@ -1068 +1068 @@
      * @since 2.1.0
      *
-     * @param array $new_schedules An array of non-default cron schedules. Default empty.
+     * @param array[] $new_schedules An array of non-default cron schedule arrays. Default empty.
      */
     return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );

trunk/src/wp-includes/formatting.php

@@ -3540 +3540 @@
  * Given a date in UTC or GMT timezone, returns that date in the timezone of the site.
  *
- * Requires and returns a date in the Y-m-d H:i:s format.
- * Return format can be overridden using the $format parameter.
+ * Requires a date in the Y-m-d H:i:s format.
+ * Default return format of 'Y-m-d H:i:s' can be overridden using the `$format` parameter.
  *
  * @since 1.2.0

trunk/src/wp-includes/theme.php

@@ -3074 +3074 @@
  *                                    Valid values are 'string', 'boolean', 'integer',
  *                                    'number', 'array', and 'object'. Defaults to 'boolean'.
- *     @type boolean    $variadic     Does this feature utilize the variadic support
+ *     @type bool       $variadic     Does this feature utilize the variadic support
  *                                    of add_theme_support(), or are all arguments specified
  *                                    as the second parameter. Must be used with the "array" type.

trunk/src/wp-login.php

@@ -435 +435 @@
  * Possible hook names include:
  *
- *  - 'login_form_checkemail'
- *  - 'login_form_confirm_admin_email'
- *  - 'login_form_confirmaction'
- *  - 'login_form_entered_recovery_mode'
- *  - 'login_form_login'
- *  - 'login_form_logout'
- *  - 'login_form_lostpassword'
- *  - 'login_form_postpass'
- *  - 'login_form_register'
- *  - 'login_form_resetpass'
- *  - 'login_form_retrievepassword'
- *  - 'login_form_rp'
+ *  - `login_form_checkemail`
+ *  - `login_form_confirm_admin_email`
+ *  - `login_form_confirmaction`
+ *  - `login_form_entered_recovery_mode`
+ *  - `login_form_login`
+ *  - `login_form_logout`
+ *  - `login_form_lostpassword`
+ *  - `login_form_postpass`
+ *  - `login_form_register`
+ *  - `login_form_resetpass`
+ *  - `login_form_retrievepassword`
+ *  - `login_form_rp`
  *
  * @since 2.8.0