Docs: Fix some documentation errors in bundled themes.

See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48101 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2020-06-20 07:22:31 +00:00
parent 1db25e3d38
commit bcdaf86a42
4 changed files with 13 additions and 13 deletions

View File

@ -34,8 +34,8 @@ function twentynineteen_get_social_link_svg( $uri, $size = 24 ) {
* @param string $item_output The menu item output.
* @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 ) {
// Change SVG icon inside social links menu if there is supported URL.

View File

@ -311,9 +311,9 @@ function twentyseventeen_fonts_url() {
*
* @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 ) {
if ( wp_style_is( 'twentyseventeen-fonts', 'queue' ) && 'preconnect' === $relation_type ) {

View File

@ -120,8 +120,8 @@ function twentyseventeen_get_svg( $args = array() ) {
* @param string $item_output The menu item output.
* @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 ) {
// Get supported social icons.
@ -145,9 +145,9 @@ add_filter( 'walker_nav_menu_start_el', 'twentyseventeen_nav_menu_social_icons',
*
* @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 ) {
if ( 'top' === $args->theme_location ) {
@ -165,7 +165,7 @@ add_filter( 'nav_menu_item_title', 'twentyseventeen_dropdown_icon_to_menu_link',
/**
* 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() {
// Supported social links icons.

View File

@ -238,9 +238,9 @@ add_action( 'after_setup_theme', 'twentysixteen_content_width', 0 );
*
* @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 ) {
if ( wp_style_is( 'twentysixteen-fonts', 'queue' ) && 'preconnect' === $relation_type ) {