WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/01/2021 12:58:34 PM (5 years ago)
Author:
SergeyBiryukov
Message:

Twenty Twenty-One: Improve documentation per the documentation standards:

  • Remove unnecessary @access tags that were previously removed from core.
  • Remove an empty line between @param and @return tags.
  • Correct alignment of @param tags.

Follow-up to [41161], [41162], [41168], [49216], [49220].

See #52628, #53461.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-custom-colors.php

    r51236 r51294  
    1515        /**
    1616         * Instantiate the object.
    17          *
    18          * @access public
    1917         *
    2018         * @since Twenty Twenty-One 1.0
    … …  
    3533         * Determine the luminance of the given color and then return #fff or #000 so that the text is always readable.
    3634         *
    37          * @access public
     35         * @since Twenty Twenty-One 1.0
    3836         *
    3937         * @param string $background_color The background color.
    40          *
    41          * @since Twenty Twenty-One 1.0
    42          *
    4338         * @return string (hex color)
    4439         */
    … …  
    5449         * The code below needs to be updated, because the colors are no longer theme mods.
    5550         *
    56          * @access public
    57          *
    5851         * @since Twenty Twenty-One 1.0
    5952         *
    6053         * @param string|null $context Can be "editor" or null.
    61          *
    6254         * @return string
    6355         */
    … …  
    8880         * Customizer & frontend custom color variables.
    8981         *
    90          * @access public
    91          *
    9282         * @since Twenty Twenty-One 1.0
    9383         *
    … …  
    10292        /**
    10393         * Editor custom color variables.
    104          *
    105          * @access public
    10694         *
    10795         * @since Twenty Twenty-One 1.0
    … …  
    128116         * @static
    129117         *
    130          * @access public
    131          *
    132118         * @since Twenty Twenty-One 1.0
    133119         *
    134120         * @param string $hex The HEX color.
    135          *
    136121         * @return int Returns a number (0-255).
    137122         */
    … …  
    159144         * Adds a class to <body> if the background-color is dark.
    160145         *
    161          * @access public
    162          *
    163146         * @since Twenty Twenty-One 1.0
    164147         *
    165148         * @param array $classes The existing body classes.
    166          *
    167149         * @return array
    168150         */
Note: See TracChangeset for help on using the changeset viewer.