ResponsiveImagesCG / wp-tevko-responsive-images

Fully responsive image plugin for wordpress
449 stars 53 forks source link

Reduce @see tags #248

Closed jaspermdegroot closed 8 years ago

joemcgill commented 8 years ago

As I understand it, @see attributes should really only reference one function name. In the cases where both wp_get_attachment_sizes() and wp_calculate_image_sizes() are referenced, I would opt for the function being used, which is generally wp_get_attachment_sizes().

jaspermdegroot commented 8 years ago

In the phpDoc manual I read "...unlimited number of values separated by commas". Nevertheless, I agree that just referring to wp_get_attachment_image_sizes() is sufficient. There we refer to `wp_calculate_image_sizes(). The same goes for the srcset functions. I also noticed that we should wrap the function names in quotes or backticks. Will update this PR.

Update: Actually we don't use @see in wp_get_attachment_image_sizes() to refer to wp_calculate_image_sizes() but I think it's fine to just refer to wp_get_attachment_image_sizes()

jaspermdegroot commented 8 years ago

Manually merged