Changeset 51283

Timestamp:

06/30/2021 04:22:22 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing @since tags for some WP_Theme_JSON methods.

Docs: Update syntax for multi-line comments per the documentation standards.

Follow-up to [50959], [50967], [50973], [51051], [51089], [51149].

See #52628, #53461.

File:

• trunk/src/wp-includes/class-wp-theme-json.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-theme-json.php

@@ -397 +397 @@
             }
 
-            // Assign defaults, then overwrite those that the block sets by itself.
-            // If the block selector is compounded, will append the element to each
-            // individual block selector.
+            /*
+             * Assign defaults, then overwrite those that the block sets by itself.
+             * If the block selector is compounded, will append the element to each
+             * individual block selector.
+             */
             $block_selectors = explode( ',', self::$blocks_metadata[ $block_name ]['selector'] );
             foreach ( self::ELEMENTS as $el_name => $el_selector ) {
@@ -643 +645 @@
      * "h1.some-class, h2.some-class, h3.some-class".
      *
+     * @since 5.8.0
+     *
      * @param string $selector Original selector.
      * @param string $to_append Selector to append.
@@ -662 +666 @@
      * it returns an array where each key is the preset slug and each value the preset value.
      *
+     * @since 5.8.0
+     *
      * @param array  $preset_per_origin Array of presets keyed by origin.
      * @param string $value_key         The property of the preset that contains its value.
@@ -674 +680 @@
             }
             foreach ( $preset_per_origin[ $origin ] as $preset ) {
-                // We don't want to use kebabCase here,
-                // see https://github.com/WordPress/gutenberg/issues/32347
-                // However, we need to make sure the generated class or css variable
-                // doesn't contain spaces.
+                /*
+                 * We don't want to use kebabCase here,
+                 * see https://github.com/WordPress/gutenberg/issues/32347
+                 * However, we need to make sure the generated class or CSS variable
+                 * doesn't contain spaces.
+                 */
                 $result[ preg_replace( '/\s+/', '-', $preset['slug'] ) ] = $preset[ $value_key ];
             }
@@ -869 +877 @@
         $properties = array();
         foreach ( self::PROPERTIES_METADATA as $name => $metadata ) {
-            // Some properties can be shorthand properties, meaning that
-            // they contain multiple values instead of a single one.
-            // An example of this is the padding property.
+            /*
+             * Some properties can be shorthand properties, meaning that
+             * they contain multiple values instead of a single one.
+             * An example of this is the padding property.
+             */
             if ( self::has_properties( $metadata ) ) {
                 foreach ( $metadata['properties'] as $property ) {
@@ -1083 +1093 @@
     /**
      * Merge new incoming data.
+     *
+     * @since 5.8.0
      *
      * @param WP_Theme_JSON $incoming Data to merge.