Make WordPress Core


Ignore:
Timestamp:
07/01/2021 12:58:34 PM (3 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-dark-mode.php

    r51246 r51294  
    1616     * Instantiate the object.
    1717     *
    18      * @access public
    19      *
    2018     * @since Twenty Twenty-One 1.0
    2119     */
     
    4947    /**
    5048     * Editor custom color variables & scripts.
    51      *
    52      * @access public
    5349     *
    5450     * @since Twenty Twenty-One 1.0
     
    8985     * Enqueue scripts and styles.
    9086     *
    91      * @access public
    92      *
    9387     * @since Twenty Twenty-One 1.0
    9488     *
     
    108102    /**
    109103     * Enqueue scripts for the customizer.
    110      *
    111      * @access public
    112104     *
    113105     * @since Twenty Twenty-One 1.0
     
    131123     * Register customizer options.
    132124     *
    133      * @access public
    134      *
    135125     * @since Twenty Twenty-One 1.0
    136126     *
    137127     * @param WP_Customize_Manager $wp_customize Theme Customizer object.
    138      *
    139128     * @return void
    140129     */
     
    223212     * Calculate classes for the main <html> element.
    224213     *
    225      * @access public
    226      *
    227214     * @since Twenty Twenty-One 1.0
    228215     *
    229216     * @param string $classes The classes for <html> element.
    230      *
    231217     * @return string
    232218     */
     
    248234     * Adds a class to the <body> element in the editor to accommodate dark-mode.
    249235     *
    250      * @access public
    251      *
    252236     * @since Twenty Twenty-One 1.0
    253237     *
    254238     * @param string $classes The admin body-classes.
    255      *
    256239     * @return string
    257240     */
     
    280263    /**
    281264     * Determine if we want to print the dark-mode switch or not.
    282      *
    283      * @access public
    284265     *
    285266     * @since Twenty Twenty-One 1.0
     
    299280     * Add night/day switch.
    300281     *
    301      * @access public
    302      *
    303282     * @since Twenty Twenty-One 1.0
    304283     *
     
    318297     * Inspired from https://codepen.io/aaroniker/pen/KGpXZo (MIT-licensed)
    319298     *
    320      * @access public
    321      *
    322299     * @since Twenty Twenty-One 1.0
    323300     *
    324301     * @param array $attrs The attributes to add to our <button> element.
    325      *
    326302     * @return void
    327303     */
     
    379355     * Print the dark-mode switch script.
    380356     *
    381      * @access public
    382      *
    383357     * @since Twenty Twenty-One 1.0
    384358     *
     
    394368     * Adds information to the privacy policy.
    395369     *
    396      * @access public
    397      *
    398370     * @since Twenty Twenty-One 1.0
    399371     *
Note: See TracChangeset for help on using the changeset viewer.