Changeset 48101

Timestamp:

06/20/2020 07:22:31 AM (5 years ago)

Author:

johnbillion

Message:

Docs: Fix some documentation errors in bundled themes.

See #49572.

Location:

trunk/src/wp-content/themes

Files:

• twentynineteen/inc/icon-functions.php (modified) (1 diff)
• twentyseventeen/functions.php (modified) (1 diff)
• twentyseventeen/inc/icon-functions.php (modified) (3 diffs)
• twentysixteen/functions.php (modified) (1 diff)

trunk/src/wp-content/themes/twentynineteen/inc/icon-functions.php

@@ -35 +35 @@
  * @param  WP_Post $item        Menu item object.
  * @param  int     $depth       Depth of the menu.
- * @param  array   $args        wp_nav_menu() arguments.
- * @return string  $item_output The menu item output with social icon.
+ * @param  object  $args        wp_nav_menu() arguments.
+ * @return string The menu item output with social icon.
  */
 function twentynineteen_nav_menu_social_icons( $item_output, $item, $depth, $args ) {

trunk/src/wp-content/themes/twentyseventeen/functions.php

@@ -312 +312 @@
  * @since Twenty Seventeen 1.0
  *
- * @param array  $urls           URLs to print for resource hints.
- * @param string $relation_type  The relation type the URLs are printed.
- * @return array $urls           URLs to print for resource hints.
+ * @param array  $urls          URLs to print for resource hints.
+ * @param string $relation_type The relation type the URLs are printed.
+ * @return array URLs to print for resource hints.
  */
 function twentyseventeen_resource_hints( $urls, $relation_type ) {

trunk/src/wp-content/themes/twentyseventeen/inc/icon-functions.php

@@ -121 +121 @@
  * @param  WP_Post $item        Menu item object.
  * @param  int     $depth       Depth of the menu.
- * @param  array   $args        wp_nav_menu() arguments.
- * @return string  $item_output The menu item output with social icon.
+ * @param  object  $args        wp_nav_menu() arguments.
+ * @return string The menu item output with social icon.
  */
 function twentyseventeen_nav_menu_social_icons( $item_output, $item, $depth, $args ) {
@@ -146 +146 @@
  * @param  string  $title The menu item's title.
  * @param  WP_Post $item  The current menu item.
- * @param  array   $args  An array of wp_nav_menu() arguments.
+ * @param  object  $args  An array of wp_nav_menu() arguments.
  * @param  int     $depth Depth of menu item. Used for padding.
- * @return string  $title The menu item's title with dropdown icon.
+ * @return string The menu item's title with dropdown icon.
  */
 function twentyseventeen_dropdown_icon_to_menu_link( $title, $item, $args, $depth ) {
@@ -166 +166 @@
  * Returns an array of supported social links (URL and icon name).
  *
- * @return array $social_links_icons
+ * @return array Array of social links icons.
  */
 function twentyseventeen_social_links_icons() {

trunk/src/wp-content/themes/twentysixteen/functions.php

@@ -239 +239 @@
  * @since Twenty Sixteen 1.6
  *
- * @param array  $urls           URLs to print for resource hints.
- * @param string $relation_type  The relation type the URLs are printed.
- * @return array $urls           URLs to print for resource hints.
+ * @param array  $urls          URLs to print for resource hints.
+ * @param string $relation_type The relation type the URLs are printed.
+ * @return array URLs to print for resource hints.
  */
 function twentysixteen_resource_hints( $urls, $relation_type ) {