[development] Documentation proposal: Forms

Jeff Eaton jeff at viapositiva.net
Sat Jul 14 05:26:33 UTC 2007

Two thumbs up on this. To clarify, this would apply to the 'builder  
functions' that directly assemble the form arrays. @see links would  
be used to connect the builder functions to their respective submit  
and validate handlers; only the builder functions themselves would  
use @ingroup form. It's a logical way to divide things, I think, and  
would make navigating around the API namespace a lot easier.


On Jul 13, 2007, at 8:26 PM, Earl Miles wrote:

> I would like propose that Drupal 6 (and forward) adopts the  
> following documentation standard:
> For all functions that are meant to be used in as an argument for  
> drupal_get_form, we document them with @ingroup forms (note that  
> actual form code is documented via @ingroup form) and we put a  
> description of what the form is meant to be used for. That will  
> make it a little easier to for users to discover what forms are  
> available and find their way to the code that generates the forms.
> (Could also use volunteers to help apply documentation patches to  
> get this done).

More information about the development mailing list