Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
It looks like we don't always include $form
and $form_state
@param
directives in DocBlock comments, and I'm told we're meant to exclude them. However, I don't find any mention of such a policy in the Doxygen and comment formatting conventions. If we have one, I propose we document it there. If not, then we're missing a lot of @param
directives in core. (The Drupal Code Sniffer flags their omissions as errors.)
Comments
Comment #1
TravisCarden CreditAttribution: TravisCarden commentedComment #2
jhodgdonhttp://drupal.org/node/1354#forms
has the examples for the structure that was discussed and agreed upon a while back on another issue.
I just added a note so that it explicitly mentions not putting in those @param and @return values, which I thought was there but apparently not.
Comment #3
TravisCarden CreditAttribution: TravisCarden commentedThanks, @jhodgdon! I've filed #1512368: Don't complain about missing $form/$form_state @param directives in the Drupal Code Sniffer queue.