Changeset 30569 for trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php

Timestamp:

11/25/2014 08:56:33 PM (10 years ago)

Author:

iandstewart

Message:

Twenty Fifteen: docs correction and cleanup.

Props DrewAPicture, see #30149.

File:

• trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php (modified) (8 diffs)

trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php

@@ -1 +1 @@
 <?php
 /**
- * Twenty Fifteen Customizer.
+ * Twenty Fifteen Customizer functionality
  *
  * @package WordPress
@@ -77 +77 @@
 /**
  * Register color schemes for Twenty Fifteen.
- * Can be filtered with twentyfifteen_color_schemes.
+ *
+ * Can be filtered with {@see 'twentyfifteen_color_schemes'}.
  *
  * The order of colors in a colors array:
@@ -164 +165 @@
 if ( ! function_exists( 'twentyfifteen_get_color_scheme' ) ) :
 /**
- * Returns an array of either the current or default color scheme hex values.
- *
- * @since Twenty Fifteen 1.0
- *
- * @return array
+ * Get the current Twenty Fifteen color scheme.
+ *
+ * @since Twenty Fifteen 1.0
+ *
+ * @return array An associative array of either the current or default color scheme hex values.
  */
 function twentyfifteen_get_color_scheme() {
@@ -188 +189 @@
  * @since Twenty Fifteen 1.0
  *
- * @return array
+ * @return array Array of color schemes.
  */
 function twentyfifteen_get_color_scheme_choices() {
@@ -209 +210 @@
  *
  * @param string $value Color scheme name value.
- *
  * @return string Color scheme name.
  */
@@ -227 +227 @@
  *
  * @since Twenty Fifteen 1.0
+ *
+ * @see wp_add_inline_style()
  */
 function twentyfifteen_color_scheme_css() {
@@ -243 +245 @@
 /**
  * Binds JS listener to make Customizer color_scheme control.
+ *
  * Passes color scheme data as colorScheme global.
  *
@@ -266 +269 @@
  * Output an Underscore template for generating CSS for the color scheme.
  *
- * The template generates the css dynamically for instant display in the Customizer preview,
- * and to be saved in a `theme_mod` for display on the front-end.
+ * The template generates the css dynamically for instant display in the Customizer
+ * preview, and to be saved in a `theme_mod` for display on the front-end.
  *
  * @since Twenty Fifteen 1.0