API page: http://api.drupal.org/api/drupal/modules--field--field.crud.inc/function...

'@throw' should be '@throws', and the exception class should probably be on the same line too?

There are three instances of this in modules/field/field.crud.inc.

CommentFileSizeAuthor
#5 1345152-field_create_field_documentation.patch1.06 KBchris.leversuch
#1 field_create_field_Documentation_1345152_1.patch969 bytesZgear

Comments

Zgear’s picture

Zgear commented
StatusFileSize
new field_create_field_Documentation_1345152_1.patch969 bytes

Will this do?

Zgear’s picture

Zgear commented
Status: Active » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work
Issue tags: +Needs backport to D7

Thanks! This is nearly perfect. The only thing is that there should be only one space between @throws and the exception name. See http://drupal.org/node/1354#classes for standards. Also a blank line should be left between the @return documentation and the @throws.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: Documentation problem with field_create_field » field_create_field and related functions have incorrect exception throwing docs
chris.leversuch’s picture

chris.leversuch commented
Status: Needs work » Needs review
StatusFileSize
new 1345152-field_create_field_documentation.patch1.06 KB

Is this patch suitable?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Yes, that's it -- thanks!

dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to 8.x and backported to 7.x. Marking 'fixed'. Thanks.

Automatically closed -- issue fixed for 2 weeks with no activity.