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

Timestamp:

05/17/2023 11:56:47 AM (16 months 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-rule.php (modified) (3 diffs)

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

@@ -37 +37 @@
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @since 6.1.0
      *
-     * @param string                                    $selector     The CSS selector.
-     * @param string[]|WP_Style_Engine_CSS_Declarations $declarations An associative array of CSS definitions, e.g., `array( "$property" => "$value", "$property" => "$value" )`,
+     * @param string                                    $selector     Optional. The CSS selector. Default empty string.
+     * @param string[]|WP_Style_Engine_CSS_Declarations $declarations Optional. An associative array of CSS definitions,
+     *                                                                e.g. `array( "$property" => "$value", "$property" => "$value" )`,
      *                                                                or a WP_Style_Engine_CSS_Declarations object.
+     *                                                                Default empty array.
      */
     public function __construct( $selector = '', $declarations = array() ) {
@@ -68 +70 @@
      * @since 6.1.0
      *
-     * @param array|WP_Style_Engine_CSS_Declarations $declarations An array of declarations (property => value pairs),
-     *                                                             or a WP_Style_Engine_CSS_Declarations object.
+     * @param string[]|WP_Style_Engine_CSS_Declarations $declarations An array of declarations (property => value pairs),
+     *                                                                or a WP_Style_Engine_CSS_Declarations object.
      * @return WP_Style_Engine_CSS_Rule Returns the object to allow chaining of methods.
      */
@@ -115 +117 @@
      * @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
      */