The Doxygen and comment formatting conventions handbook page states the following:

@param and @return for the standard parameters and return value should be omitted from all form-generating functions. Do include @param documentation for additional parameters beyond $form and $form_state, if there are any.

If you observe this policy, however, Drupal_Sniffs_Commenting_FunctionCommentSniff::processParams(), complains that "Doc comment for var $documented does not match actual variable name $actual at position x". Can the sniff be adjusted to correctly reflect our policy?

Comments

klausi’s picture

Status: Active » Fixed

Thanks for reporting this. Not a trivial fix, but I think I got it right. Now it is allowed to document just a subset of the available function parameters.

Fixed in this commit: http://drupalcode.org/project/drupalcs.git/commit/e69738b

Please test.

traviscarden’s picture

It works great. Thanks!!

Status: Fixed » Closed (fixed)

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