Changeset 59090 for trunk/src/wp-content/themes/twentynineteen/inc/helper-functions.php

Timestamp:

09/25/2024 06:06:27 PM (17 months ago)

Author:

SergeyBiryukov

Message:

Twenty Nineteen: Add missing documentation for helper function parameters.

Follow-up to [43808], [44149], [47214], [47242].

Props pitamdey.
Fixes #62112.

File:

• trunk/src/wp-content/themes/twentynineteen/inc/helper-functions.php (modified) (2 diffs)

trunk/src/wp-content/themes/twentynineteen/inc/helper-functions.php

@@ -33 +33 @@
  *
  * @see get_comment_class()
+ *
+ * @param WP_Comment|null $comment The comment object to check. Defaults to the current comment.
+ * @return bool True if the comment is by the author of the post, false otherwise.
  */
 function twentynineteen_is_comment_by_post_author( $comment = null ) {
@@ -83 +86 @@
 
 /**
- * Converts HSL to HEX colors.
+ * Converts HSL to HEX or RGB colors.
+ *
+ * @param float $h      The hue component (0-360).
+ * @param float $s      The saturation component (0-100).
+ * @param float $l      The lightness component (0-100).
+ * @param bool  $to_hex Whether to convert to HEX format (true) or RGB (false). Default true.
  */
 function twentynineteen_hsl_hex( $h, $s, $l, $to_hex = true ) {