WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
12/03/2013 05:05:53 PM (11 years ago)
Author:
lancewillett
Message:

Twenty Fourteen: update comment blocks to match inline docs standards. Props DrewAPicture, see #25837.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-content/themes/twentyfourteen/inc/customizer.php

    r26555 r26556  
    7373
    7474/**
    75  * Tweak the brightness of a color by adjusting the RGB values by the given interval.
    76  *
    77  * Use positive values of $steps to brighten the color and negative values to darken the color.
    78  * All three RGB values are modified by the specified steps, within the range of 0-255. The hue
    79  * is generally maintained unless the number of steps causes one value to be capped at 0 or 255.
     75 * Tweak the brightness of a color by adjusting the RGB
     76 * values by the given interval.
     77 *
     78 * Use positive values of $steps to brighten the color and negative
     79 * values to darken the color. All three RGB values are modified by
     80 * the specified steps, within the range of 0-255. The hue is generally
     81 * maintained unless the number of steps causes one value to be capped
     82 * at 0 or 255.
    8083 *
    8184 * @since Twenty Fourteen 1.0
    8285 *
    8386 * @param string $color The original color, in 3- or 6-digit hexadecimal form.
    84  * @param int $steps The number of steps to adjust the color by, in RGB units.
     87 * @param int    $steps The number of steps to adjust the color by, in RGB units.
    8588 * @return string $color The new color, in 6-digit hexadecimal form.
    8689 */
    … …  
    110113
    111114 /**
    112  * Returns a slightly lighter color than what is set as the theme's
     115 * Return a slightly lighter color than what is set as the theme's
    113116 * accent color.
    114117 *
    115118 * @since Twenty Fourteen 1.0
    116119 *
    117  * @return string
     120 * @return string Hex color.
    118121 */
    119122function twentyfourteen_accent_mid() {
    … …  
    122125
    123126/**
    124  * Returns a lighter color than what is set as the theme's accent color.
    125  *
    126  * @since Twenty Fourteen 1.0
    127  *
    128  * @return string
     127 * Return a lighter color than what is set as the theme's accent color.
     128 *
     129 * @since Twenty Fourteen 1.0
     130 *
     131 * @return string Hex color.
    129132 */
    130133function twentyfourteen_accent_light() {
    … …  
    133136
    134137/**
    135  * Caches the generated variants of the theme's accent color.
     138 * Cache the generated variants of the theme's accent color.
    136139 *
    137140 * @since Twenty Fourteen 1.0
    … …  
    325328
    326329/**
    327  * Adds contextual help to the Themes and Post edit screens.
     330 * Add contextual help to the Themes and Post edit screens.
    328331 *
    329332 * @since Twenty Fourteen 1.0
Note: See TracChangeset for help on using the changeset viewer.