Twenty Fifteen, Twenty Seventeen: Add documentation to filters in themes.

Documents a missing one Twenty Fifteen and all four missing ones in Twenty Seventeen.

Props brainstormforce.

Fixes #38382.


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

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

@@ -118,6 +118,19 @@ function twentyfifteen_setup() {
 	$default_color = trim( $color_scheme[0], '#' );
 
 	// Setup the WordPress core custom background feature.
+
+	/**
+	 * Filter Twenty Fifteen custom-header support arguments.
+	 *
+	 * @since Twenty Fifteen 1.0
+	 *
+	 * @param array $args {
+	 *     An array of custom-header support arguments.
+	 *
+	 *     @type string $default-color     		Default color of the header.
+	 *     @type string $default-attachment     Default attachment of the header.
+	 * }
+	 */
 	add_theme_support( 'custom-background', apply_filters( 'twentyfifteen_custom_background_args', array(
 		'default-color'      => $default_color,
 		'default-attachment' => 'fixed',

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

@@ -117,6 +117,13 @@ function twentyseventeen_content_width() {
 		$content_width = 1120;
 	}
 
+	/**
+	 * Filter Twenty Seventeen content width of the theme.
+	 *
+	 * @since Twenty Seventeen 1.0
+	 *
+	 * @param $content_width integer
+	 */
 	$GLOBALS['content_width'] = apply_filters( 'twentyseventeen_content_width', $content_width );
 }
 add_action( 'after_setup_theme', 'twentyseventeen_content_width', 0 );

src/wp-content/themes/twentyseventeen/inc/color-patterns.php

@@ -12,6 +12,14 @@
  */
 function twentyseventeen_custom_colors_css() {
 	$hue = get_theme_mod( 'colorscheme_hue', 250 );
+
+	/**
+	 * Filter Twenty Seventeen default saturation level.
+	 *
+	 * @since Twenty Seventeen 1.0
+	 *
+	 * @param $saturation integer
+	 */
 	$saturation = apply_filters( 'twentyseventeen_custom_colors_saturation', 50 );
 	$reduced_saturation = ( .8 * $saturation ) . '%';
 	$saturation = $saturation . '%';

src/wp-content/themes/twentyseventeen/inc/custom-header.php

@@ -15,6 +15,24 @@
  * @uses twentyseventeen_header_style()
  */
 function twentyseventeen_custom_header_setup() {
+
+	/**
+	 * Filter Twenty Seventeen custom-header support arguments.
+	 *
+	 * @since Twenty Seventeen 1.0
+	 *
+	 * @param array $args {
+	 *     An array of custom-header support arguments.
+	 *
+	 *     @type string $default-image     		Default image of the header.
+	 *     @type string $default_text_color     Default color of the header text.
+	 *     @type int    $width                  Width in pixels of the custom header image. Default 954.
+	 *     @type int    $height                 Height in pixels of the custom header image. Default 1300.
+	 *     @type string $wp-head-callback       Callback function used to styles the header image and text
+	 *                                          displayed on the blog.
+	 *     @type string $flex-height     		Flex support for height of header.
+	 * }
+	 */
 	add_theme_support( 'custom-header', apply_filters( 'twentyseventeen_custom_header_args', array(
 		'default-image'      => get_parent_theme_file_uri( '/assets/images/header.jpg' ),
 		'default-text-color' => 'ffffff',

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

@@ -195,5 +195,12 @@ function twentyseventeen_social_links_icons() {
 		'youtube.com'     => 'youtube',
 	);
 
+	/**
+	 * Filter Twenty Seventeen social links icons.
+	 *
+	 * @since Twenty Seventeen 1.0
+	 *
+	 * @param array $social_links_icons
+	 */
 	return apply_filters( 'twentyseventeen_social_links_icons', $social_links_icons );
 }