Context Navigation

Changeset 59090

Timestamp:

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

Author:

SergeyBiryukov

Message:

Twenty Nineteen: Add missing documentation for helper function parameters.

Props pitamdey.
Fixes #62112.

Location:

trunk/src/wp-content/themes/twentynineteen

Files:

-                      r56547
+                      r59090
     /**
      * Gets the SVG code for a given icon.
+     *
+     * @param string $group The group of icons ('ui' or 'social').
+     * @param string $icon  The specific icon to retrieve.
+     * @param int    $size  The desired width and height for the SVG icon.
      */
     public static function get_svg( $group, $icon, $size ) {
 …
     /**
      * Detects the social network from a URL and returns the SVG code for its icon.
+     *
+     * @param string $uri  The URL of the social network link.
+     * @param int    $size The desired width and height for the SVG icon.
      */
     public static function get_social_link_svg( $uri, $size ) {

r59026	r59090
11	11	* @since Twenty Nineteen 1.0
12	12	*/
	13
13	14	?><!doctype html>
14	15	<html <?php language_attributes(); ?>>

-                      r49602
+                      r59090
+ *
  * @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 ) {
 …
 /**
+ * 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 ) {

Note: See TracChangeset for help on using the changeset viewer.