Changeset 54411

Timestamp:

10/07/2022 11:59:18 AM (2 years ago)

Author:

audrasjb

Message:

Docs: Various docblock fixes in WP_Theme_JSON class, as per documentation standards.

Follow-up to [54408].

See #55646.

File:

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

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

@@ -684 +684 @@
      * @param string $to_append Selector to append.
      * @param string $position  A position sub-selector should be appended. Default 'right'.
-     * @return string
+     * @return string The new selector.
      */
     protected static function append_to_selector( $selector, $to_append, $position = 'right' ) {
@@ -800 +800 @@
      * @param array $tree   Input to process.
      * @param array $schema Schema to adhere to.
-     * @return array Returns the modified $tree.
+     * @return array The modified $tree.
      */
     protected static function remove_keys_not_in_schema( $tree, $schema ) {
@@ -866 +866 @@
      *                       - `presets`: only the classes for the presets.
      * @param array $origins A list of origins to include. By default it includes VALID_ORIGINS.
-     * @return string Stylesheet.
+     * @return string The resulting stylesheet.
      */
     public function get_stylesheet( $types = array( 'variables', 'styles', 'presets' ), $origins = null ) {
@@ -1012 +1012 @@
 
     /**
-     * Get the CSS layout rules for a particular block from theme.json layout definitions.
+     * Gets the CSS layout rules for a particular block from theme.json layout definitions.
      *
      * @since 6.1.0
      *
      * @param array $block_metadata Metadata about the block to get styles for.
-     *
      * @return string Layout styles for the block.
      */
@@ -1287 +1286 @@
      * @param string $selector     CSS selector.
      * @param array  $declarations List of declarations.
-     * @return string CSS ruleset.
+     * @return string The resulting CSS ruleset.
      */
     protected static function to_ruleset( $selector, $declarations ) {
@@ -1305 +1304 @@
 
     /**
-     * Given a settings array, it returns the generated rulesets
+     * Given a settings array, returns the generated rulesets
      * for the preset classes.
      *
@@ -1478 +1477 @@
 
     /**
-     * Transform a slug into a CSS Custom Property.
+     * Transforms a slug into a CSS Custom Property.
      *
      * @since 5.9.0
@@ -1491 +1490 @@
 
     /**
-     * Given the block settings, it extracts the CSS Custom Properties
+     * Given the block settings, extracts the CSS Custom Properties
      * for the presets and adds them to the $declarations array
      * following the format:
@@ -1505 +1504 @@
      * @param array $settings Settings to process.
      * @param array $origins  List of origins to process.
-     * @return array Returns the modified $declarations.
+     * @return array The modified $declarations.
      */
     protected static function compute_preset_vars( $settings, $origins ) {
@@ -1523 +1522 @@
 
     /**
-     * Given an array of settings, it extracts the CSS Custom Properties
+     * Given an array of settings, extracts the CSS Custom Properties
      * for the custom values and adds them to the $declarations
      * array following the format:
@@ -1535 +1534 @@
      *
      * @param array $settings Settings to process.
-     * @return array Returns the modified $declarations.
+     * @return array The modified $declarations.
      */
     protected static function compute_theme_vars( $settings ) {
@@ -1792 +1791 @@
      * @param array $theme_json The tree to extract setting nodes from.
      * @param array $selectors  List of selectors per block.
-     * @return array
+     * @return array An array of setting nodes metadata.
      */
     protected static function get_setting_nodes( $theme_json, $selectors = array() ) {
@@ -1846 +1845 @@
      * @param array $theme_json The tree to extract style nodes from.
      * @param array $selectors  List of selectors per block.
-     * @return array
+     * @return array An array of style nodes metadata.
      */
     protected static function get_style_nodes( $theme_json, $selectors = array() ) {
@@ -2232 +2231 @@
 
     /**
-     * Merge new incoming data.
+     * Merges new incoming data.
      *
      * @since 5.8.0
@@ -2351 +2350 @@
 
     /**
-     * Returns whether a presets should be overridden or not.
+     * Determines whether a presets should be overridden or not.
      *
      * @since 5.9.0
@@ -2439 +2438 @@
 
     /**
-     * Get a `default`'s preset name by a provided slug.
+     * Gets a `default`'s preset name by a provided slug.
      *
      * @since 5.9.0