Changeset 30569

Timestamp:

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

Author:

iandstewart

Message:

Twenty Fifteen: docs correction and cleanup.

Props DrewAPicture, see #30149.

Location:

trunk/src/wp-content/themes/twentyfifteen

Files:

• functions.php (modified) (4 diffs)
• inc/back-compat.php (modified) (1 diff)
• inc/custom-header.php (modified) (4 diffs)
• inc/customizer.php (modified) (8 diffs)
• inc/template-tags.php (modified) (5 diffs)

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

@@ -148 +148 @@
  * @since Twenty Fifteen 1.0
  *
- * @return string
+ * @return string Google fonts URL for the theme.
  */
 function twentyfifteen_fonts_url() {
@@ -246 +246 @@
  *
  * @since Twenty Fifteen 1.0
+ *
+ * @see wp_add_inline_style()
  */
 function twentyfifteen_post_nav_background() {
@@ -291 +293 @@
  * @param int     $depth       Depth of the menu.
  * @param array   $args        wp_nav_menu() arguments.
- *
  * @return string Menu item with possible description.
  */
@@ -308 +309 @@
  * @since Twenty Fifteen 1.0
  *
- * @param string $html Search form HTML
- *
- * @return string Modified search form HTML
+ * @param string $html Search form HTML.
+ * @return string Modified search form HTML.
  */
 function twentyfifteen_search_form_modify( $html ) {

trunk/src/wp-content/themes/twentyfifteen/inc/back-compat.php

@@ -1 +1 @@
 <?php
 /**
- * Twenty Fifteen back compat functionality.
+ * Twenty Fifteen back compat functionality
  *
  * Prevents Twenty Fifteen from running on WordPress versions prior to 4.1,
- * since this theme is not meant to be backward compatible beyond that
- * and relies on many newer functions and markup changes introduced in 4.1.
+ * since this theme is not meant to be backward compatible beyond that and
+ * relies on many newer functions and markup changes introduced in 4.1.
  *
  * @package WordPress

trunk/src/wp-content/themes/twentyfifteen/inc/custom-header.php

@@ -1 +1 @@
 <?php
 /**
- * Implement Custom Header functionality for Twenty Fifteen.
+ * Custom Header functionality for Twenty Fifteen
  *
  * @package WordPress
@@ -47 +47 @@
  *
  * @param string $color The original color, in 3- or 6-digit hexadecimal form.
- * @return array
+ * @return array Array containing RGB (red, green, and blue) values for the given
+ *               HEX code, empty array otherwise.
  */
 function twentyfifteen_hex2rgb( $color ) {
@@ -72 +73 @@
  *
  * @since Twenty Fifteen 1.0
- * @see twentyfifteen_custom_header_setup().
+ *
+ * @see twentyfifteen_custom_header_setup()
  */
 function twentyfifteen_header_style() {
@@ -174 +176 @@
  *
  * @since Twenty Fifteen 1.0
+ *
+ * @see wp_add_inline_style()
  */
 function twentyfifteen_header_background_color_css() {

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

trunk/src/wp-content/themes/twentyfifteen/inc/template-tags.php

@@ -1 +1 @@
 <?php
 /**
- * Custom template tags for this theme.
+ * Custom template tags for Twenty Fifteen
  *
  * Eventually, some of the functionality here could be replaced by core features.
@@ -127 +127 @@
 
 /**
- * Returns true if a blog has more than 1 category.
- *
- * @since Twenty Fifteen 1.0
- *
- * @return bool
+ * Determine whether blog/site has more than one category.
+ *
+ * @since Twenty Fifteen 1.0
+ *
+ * @return bool True of there is more than one category, false otherwise.
  */
 function twentyfifteen_categorized_blog() {
@@ -160 +160 @@
 
 /**
- * Flush out the transients used in twentyfifteen_categorized_blog.
+ * Flush out the transients used in {@see twentyfifteen_categorized_blog()}.
  *
  * @since Twenty Fifteen 1.0
@@ -211 +211 @@
  *
  * @since Twenty Fifteen 1.0
- * @uses get_url_in_content()
+ *
+ * @see get_url_in_content()
  *
  * @return string The Link format URL.
@@ -224 +225 @@
 if ( ! function_exists( 'twentyfifteen_excerpt_more' ) && ! is_admin() ) :
 /**
- * Replaces "[...]" (appended to automatically generated excerpts) with ... and a Continue reading link.
- *
- * @since Twenty Fifteen 1.0
- *
+ * Replaces "[...]" (appended to automatically generated excerpts) with ... and a 'Continue reading' link.
+ *
+ * @since Twenty Fifteen 1.0
+ *
+ * @return string 'Continue reading' link prepended with an ellipsis.
  */
 function twentyfifteen_excerpt_more( $more ) {