Incorrect inline documentation

[jaspermdegroot]

These are issues in the plugin as well as in WP core trunk.

wp_get_attachment_image_srcset():

• param $image_meta missing "Default null"

wp_calculate_image_srcset():

• param $attachment_id missing "Default 0"

wp_calculate_image_srcset:

• variable $attachment_id: add to description " or 0".

wp_get_attachment_image_sizes():

• param $image_meta missing "Default null"
• Return description should be "A valid source size value for use in a 'sizes' attribute or false." instead of "A 'srcset' value string or false."

wp_calculate_image_sizes():

• description of the function: "Create 'sizes' attribute value for an image." should be "Creates the 'sizes' attribute value for an image."
• param $size: remove " Default 'medium'." since it doesn't have a default
• param $image_src should be documented as second instead of fourth
• param $image_src missing "Default null" (= null is missing in the code as well)
• param $image_meta missing "Default null" (= null is missing in the code as well)
• param $attachment_id missing "Default 0"

wp_calculate_image_sizes:

• variable $size: remove " Default 'medium'." from description
• variable $image_src type should be string|null and add to description " or null".
• variable $image_meta type should be array|null and add to description " or null".
• variable $attachment_id: add to description " or 0".

[joemcgill]

Closed after manually merging #250

[joemcgill]

I've added the changes in 88e8480 to the original ticket in Trac (#34612) for adding the wp_calculate_image_sizes() function.

All other docs changes should be handled in a big docs sweep through Core.