WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
10/11/2013 10:01:14 PM (12 years ago)
Author:
lancewillett
Message:

Twenty Fourteen: first pass for updating code comments to reflect WP inline docs standards, see #25257.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r25762 r25769  
    11<?php
    22/**
    3  * Twenty Fourteen Theme Customizer
     3 * Twenty Fourteen Theme Customizer support
    44 *
    55 * @package WordPress
    66 * @subpackage Twenty_Fourteen
     7 * @since Twenty Fourteen 1.0
    78 */
    89
    910/**
    1011 * Add postMessage support for site title and description for the Theme Customizer.
     12 *
     13 * @since Twenty Fourteen 1.0
    1114 *
    1215 * @param WP_Customize_Manager $wp_customize Theme Customizer object.
    … …  
    3033
    3134/**
    32  * Binds JS handlers to make Theme Customizer preview reload changes asynchronously.
     35 * Bind JS handlers to make Theme Customizer preview reload changes asynchronously.
     36 *
     37 * @since Twenty Fourteen 1.0
    3338 */
    3439function twentyfourteen_customize_preview_js() {
    … …  
    3843
    3944/**
    40  * Generates two variants of the accent color, returns the original, and saves the others as theme mods.
     45 * Generate two variants of the accent color, return the original, and
     46 * save the others as theme mods.
     47 *
     48 * @since Twenty Fourteen 1.0
    4149 *
    4250 * @param string $color The original color.
    … …  
    5361
    5462/**
    55  * Tweaks the brightness of a color by adjusting the RGB values by the given interval.
     63 * Tweak the brightness of a color by adjusting the RGB values by the given interval.
    5664 *
    5765 * Use positive values of $steps to brighten the color and negative values to darken the color.
    … …  
    5967 * is generally maintained unless the number of steps causes one value to be capped at 0 or 255.
    6068 *
     69 * @since Twenty Fourteen 1.0
     70 *
    6171 * @param string $color The original color, in 3- or 6-digit hexadecimal form.
    62  * @param int $steps The number of steps to adjust the color by, in rgb units.
     72 * @param int $steps The number of steps to adjust the color by, in RGB units.
    6373 * @return string $color The new color, in 6-digit hexadecimal form.
    6474 */
    … …  
    8797
    8898/**
    89  * Outputs the css for the Theme Customizer options.
     99 * Output the CSS for the Theme Customizer options.
     100 *
     101 * @since Twenty Fourteen 1.0
     102 *
     103 * @return void
    90104 */
    91105function twentyfourteen_customizer_styles() {
Note: See TracChangeset for help on using the changeset viewer.