Bundled Themes: Add missing @return tags and descriptions.

Developed in #10533

Props huzaifaalmesbah, sabernhardt, palak678, westonruter.
See #64224.
Fixes #64277.


git-svn-id: https://develop.svn.wordpress.org/trunk@61302 602fd350-edb4-49c9-b593-d223f7449a82

Author: westonruter

src/wp-content/themes/twentyeleven/functions.php

@@ -988,7 +988,9 @@ function twentyeleven_skip_link() {
 	 *
 	 * Added for backward compatibility to support pre-6.0.0 WordPress versions.
 	 *
-	 * @since 6.0.0
+	 * @since Twenty Eleven 4.1
+	 *
+	 * @return string Locale-specific list item separator.
 	 */
 	function wp_get_list_item_separator() {
 		/* translators: Used between list items, there is a space after the comma. */

src/wp-content/themes/twentyfifteen/functions.php

@@ -366,7 +366,7 @@ function twentyfifteen_widgets_init() {
 	 * @since Twenty Fifteen 1.0
 	 * @since Twenty Fifteen 3.4 Replaced Google URL with self-hosted fonts.
 	 *
-	 * @return string Fonts URL for the theme.
+	 * @return string Font stylesheet URL or empty string if disabled.
 	 */
 	function twentyfifteen_fonts_url() {
 		$fonts_url = '';

src/wp-content/themes/twentyfourteen/functions.php

@@ -315,7 +315,7 @@ function twentyfourteen_widgets_init() {
 	 * @since Twenty Fourteen 1.0
 	 * @since Twenty Fourteen 3.6 Replaced Google URL with self-hosted fonts.
 	 *
-	 * @return string
+	 * @return string Font stylesheet URL or empty string if disabled.
 	 */
 	function twentyfourteen_font_url() {
 		$font_url = '';
@@ -755,6 +755,8 @@ function twentyfourteen_register_block_patterns() {
  * `is_customize_preview` function was introduced.
  *
  * @global WP_Customize_Manager $wp_customize Customizer object.
+ *
+ * @return bool Whether the site is being previewed in the Customizer.
  */
 if ( ! function_exists( 'is_customize_preview' ) ) :
 	function is_customize_preview() {

src/wp-content/themes/twentyfourteen/inc/widgets.php

@@ -26,7 +26,7 @@ class Twenty_Fourteen_Ephemera_Widget extends WP_Widget {
 	 *
 	 * @since Twenty Fourteen 1.0
 	 *
-	 * @return Twenty_Fourteen_Ephemera_Widget
+	 * @return Twenty_Fourteen_Ephemera_Widget Widget instance.
 	 */
 	public function __construct() {
 		parent::__construct(

src/wp-content/themes/twentynineteen/classes/class-twentynineteen-svg-icons.php

@@ -27,6 +27,7 @@ class TwentyNineteen_SVG_Icons {
 	 * @param string $group The group of icons ('ui' or 'social').
 	 * @param string $icon  The specific icon to retrieve.
 	 * @param int    $size  The desired width and height for the SVG icon.
+	 * @return string|null SVG code for the icon, or null if not found.
 	 */
 	public static function get_svg( $group, $icon, $size ) {
 		if ( 'ui' === $group ) {
@@ -51,6 +52,7 @@ public static function get_svg( $group, $icon, $size ) {
 	 *
 	 * @param string $uri  The URL of the social network link.
 	 * @param int    $size The desired width and height for the SVG icon.
+	 * @return string|null SVG code for the social link icon, or null if not found.
 	 */
 	public static function get_social_link_svg( $uri, $size ) {
 		static $regex_map; // Only compute regex map once, for performance.

src/wp-content/themes/twentynineteen/functions.php

@@ -181,7 +181,9 @@ function twentynineteen_setup() {
 	 *
 	 * Added for backward compatibility to support pre-6.0.0 WordPress versions.
 	 *
-	 * @since 6.0.0
+	 * @since Twenty Nineteen 2.3
+	 *
+	 * @return string Locale-specific list item separator.
 	 */
 	function wp_get_list_item_separator() {
 		/* translators: Used between list items, there is a space after the comma. */

src/wp-content/themes/twentynineteen/inc/customizer.php

@@ -142,7 +142,7 @@ function twentynineteen_panels_js() {
  * Sanitizes custom color choice.
  *
  * @param string $choice Whether image filter is active.
- * @return string
+ * @return string Sanitized color option.
  */
 function twentynineteen_sanitize_color_option( $choice ) {
 	$valid = array(

src/wp-content/themes/twentynineteen/inc/template-functions.php

@@ -11,7 +11,7 @@
  * Adds custom classes to the array of body classes.
  *
  * @param array $classes Classes for the body element.
- * @return array
+ * @return string[] The filtered body class list.
  */
 function twentynineteen_body_classes( $classes ) {
 

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

@@ -289,7 +289,7 @@ function twentyseventeen_content_width() {
 	 * @since Twenty Seventeen 1.0
 	 * @since Twenty Seventeen 3.2 Replaced Google URL with self-hosted fonts.
 	 *
-	 * @return string Fonts URL for the theme.
+	 * @return string Font stylesheet URL or empty string if disabled.
 	 */
 	function twentyseventeen_fonts_url() {
 		$fonts_url = '';
@@ -681,7 +681,9 @@ function twentyseventeen_unique_id( $prefix = '' ) {
 	 *
 	 * Added for backward compatibility to support pre-6.0.0 WordPress versions.
 	 *
-	 * @since 6.0.0
+	 * @since Twenty Seventeen 3.0
+	 *
+	 * @return string Locale-specific list item separator.
 	 */
 	function wp_get_list_item_separator() {
 		/* translators: Used between list items, there is a space after the comma. */

src/wp-content/themes/twentyseventeen/inc/template-functions.php

@@ -11,7 +11,7 @@
  * Adds custom classes to the array of body classes.
  *
  * @param array $classes Classes for the body element.
- * @return array
+ * @return string[] Filtered body classes with theme-specific additions.
  */
 function twentyseventeen_body_classes( $classes ) {
 	// Add class of group-blog to blogs with more than 1 published author.