Incorrect return info on image_style_create_derivative(). [#1051038]

The documentation for image_style_create_derivative incorrectly lists NULL as one of the possible return values. All code paths in the function return either TRUE or FALSE.

I've also updated the doxygen block for that function to adhere better to the Doxygen and comments formatting conventions, added an additional paragraph explaining what the function does and included a @see to image_style_load for the image style array information.

Comment	File	Size	Author
#4	1051038-image-style-create-derivative-docs.patch	1.19 KB	mr.baileys
#2	1051038-image-style-create-derivative-docs.patch	1.2 KB	mr.baileys
	image-style-create-derivative-docs.patch	1.18 KB	mr.baileys

Comments

Comment #1

jhodgdon

she/her

English

commented 4 February 2011 at 15:08

Status:

Needs review

» Needs work

Good catch! Agreed with your assessment and nice work on the cleanup.

The patch still needs a couple of minor things corrected:
- Should be a comma before and in the first paragraph (our style standards require lists of a, b, and c to have a comma before the and).
- I think maybe there should be an "or" before FALSE in the @return. "TRUE if ..., or FALSE if..."