WordPress.org

Make WordPress Core

Changeset 52302


Ignore:
Timestamp:
12/01/2021 11:14:22 PM (8 weeks ago)
Author:
audrasjb
Message:

Docs: Miscellaneous Docblock corrections in several /block-supports files.

See #53399.

Location:
trunk/src/wp-includes/block-supports
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/block-supports/align.php

    r51246 r52302  
    3232
    3333/**
    34  * Add CSS classes for block alignment to the incoming attributes array.
     34 * Adds CSS classes for block alignment to the incoming attributes array.
    3535 * This will be applied to the block markup in the front-end.
    3636 *
     
    4040 * @param WP_Block_Type $block_type       Block Type.
    4141 * @param array         $block_attributes Block attributes.
    42  *
    4342 * @return array Block alignment CSS classes and inline styles.
    4443 */
  • trunk/src/wp-includes/block-supports/border.php

    r52069 r52302  
    4848 * @param WP_Block_Type $block_type       Block type.
    4949 * @param array         $block_attributes Block attributes.
    50  *
    5150 * @return array Border CSS classes and inline styles.
    5251 */
     
    146145 *
    147146 * @param WP_Block_Type $block_type Block type.
    148  *
    149  * @return bool
     147 * @return bool Whether serialization of the current block's border properties
     148 *              should occur.
    150149 */
    151150function wp_skip_border_serialization( $block_type ) {
  • trunk/src/wp-includes/block-supports/dimensions.php

    r52069 r52302  
    4141
    4242/**
    43  * Add CSS classes for block dimensions to the incoming attributes array.
     43 * Adds CSS classes for block dimensions to the incoming attributes array.
    4444 * This will be applied to the block markup in the front-end.
    4545 *
     
    4949 * @param WP_Block_Type $block_type       Block Type.
    5050 * @param array         $block_attributes Block attributes.
    51  *
    5251 * @return array Block dimensions CSS classes and inline styles.
    5352 */
     
    7372 *
    7473 * @param WP_Block_type $block_type Block type.
    75  *
    76  * @return boolean Whether to serialize spacing support styles & classes.
     74 * @return bool Whether to serialize spacing support styles & classes.
    7775 */
    7876function wp_skip_dimensions_serialization( $block_type ) {
  • trunk/src/wp-includes/block-supports/layout.php

    r52161 r52302  
    3636 * @access private
    3737 *
    38  * @param string  $selector CSS selector.
    39  * @param array   $layout   Layout object. The one that is passed has already checked the existance of default block layout.
    40  * @param boolean $has_block_gap_support Whether the theme has support for the block gap.
    41  *
     38 * @param string $selector              CSS selector.
     39 * @param array  $layout                Layout object. The one that is passed has already checked
     40 *                                      the existance of default block layout.
     41 * @param bool   $has_block_gap_support Whether the theme has support for the block gap.
    4242 * @return string CSS style.
    4343 */
     
    217217 * @param string $block_content Rendered block content.
    218218 * @param array  $block         Block object.
    219  *
    220219 * @return string Filtered block content.
    221220 */
  • trunk/src/wp-includes/block-supports/spacing.php

    r52069 r52302  
    4242 * @param WP_Block_Type $block_type       Block Type.
    4343 * @param array         $block_attributes Block attributes.
    44  *
    4544 * @return array Block spacing CSS classes and inline styles.
    4645 */
     
    8786 *
    8887 * @param WP_Block_Type $block_type Block type.
    89  *
    90  * @return boolean Whether to serialize spacing support styles & classes.
     88 * @return bool Whether to serialize spacing support styles & classes.
    9189 */
    9290function wp_skip_spacing_serialization( $block_type ) {
     
    105103 * @access private
    106104 *
    107  * @param  string $block_content Rendered block content.
    108  * @param  array  $block         Block object.
    109  * @return string                Filtered block content.
     105 * @param string $block_content Rendered block content.
     106 * @param array  $block         Block object.
     107 * @return string Filtered block content.
    110108 */
    111109function wp_render_spacing_gap_support( $block_content, $block ) {
  • trunk/src/wp-includes/block-supports/typography.php

    r52069 r52302  
    6161
    6262/**
    63  * Add CSS classes and inline styles for typography features such as font sizes
     63 * Adds CSS classes and inline styles for typography features such as font sizes
    6464 * to the incoming attributes array. This will be applied to the block markup in
    6565 * the front-end.
     
    6868 * @access private
    6969 *
    70  * @param  WP_Block_Type $block_type       Block type.
    71  * @param  array         $block_attributes Block attributes.
    72  *
     70 * @param WP_Block_Type $block_type       Block type.
     71 * @param array         $block_attributes Block attributes.
    7372 * @return array Typography CSS classes and inline styles.
    7473 */
     
    193192 * @param string $feature      Key for the feature within the typography styles.
    194193 * @param string $css_property Slug for the CSS property the inline style sets.
    195  *
    196  * @return string              CSS inline style.
     194 * @return string CSS inline style.
    197195 */
    198196function wp_typography_get_css_variable_inline_style( $attributes, $feature, $css_property ) {
Note: See TracChangeset for help on using the changeset viewer.