Changeset 55819 for trunk/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php

Timestamp:

05/17/2023 11:56:47 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve Style Engine DocBlocks per the documentation standards.

Follow-up to [54156], [55719], [55733].

See #57840.

File:

• trunk/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php (modified) (5 diffs)

trunk/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php

@@ -31 +31 @@
          *
          * If a `$declarations` array is passed, it will be used to populate
-         * the initial $declarations prop of the object by calling add_declarations().
+         * the initial `$declarations` prop of the object by calling add_declarations().
          *
          * @since 6.1.0
          *
-         * @param string[] $declarations An associative array of CSS definitions, e.g., `array( "$property" => "$value", "$property" => "$value" )`.
+         * @param string[] $declarations Optional. An associative array of CSS definitions,
+         *                               e.g. `array( "$property" => "$value", "$property" => "$value" )`.
+         *                               Default empty array.
          */
         public function __construct( $declarations = array() ) {
@@ -103 +105 @@
          * @since 6.1.0
          *
-         * @param string[] $properties An array of properties.
+         * @param string[] $properties Optional. An array of properties. Default empty array.
          * @return WP_Style_Engine_CSS_Declarations Returns the object to allow chaining methods.
          */
@@ -131 +133 @@
          * @param string $property The CSS property.
          * @param string $value    The value to be filtered.
-         * @param string $spacer   The spacer between the colon and the value. Defaults to an empty string.
+         * @param string $spacer   Optional. The spacer between the colon and the value.
+         *                         Default empty string.
          * @return string The filtered declaration or an empty string.
          */
@@ -147 +150 @@
          * @since 6.1.0
          *
-         * @param bool $should_prettify Whether to add spacing, new lines and indents.
-         * @param int  $indent_count    The number of tab indents to apply to the rule. Applies if `prettify` is `true`.
+         * @param bool $should_prettify Optional. Whether to add spacing, new lines and indents.
+         *                              Default false.
+         * @param int  $indent_count    Optional. The number of tab indents to apply to the rule.
+         *                              Applies if `prettify` is `true`. Default 0.
          * @return string The CSS declarations.
          */
@@ -165 +170 @@
                         }
                 }
+
                 return rtrim( $declarations_output );
         }