[development] Documentation proposal: Forms

Ken Rickard agentrickard at gmail.com
Sat Jul 14 03:12:14 UTC 2007


I've used this technique before and find it very helpful in compiling
documentation.  The resulting API has an entire topic devoted to FormsAPI
calls, which makes finding forms simple.

I can spare a few patch cycles if we decide to go forward.

- Ken Rickard
agentrickard

On 7/13/07, Earl Miles <merlin at logrus.com> 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).
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/development/attachments/20070713/4a25d8a6/attachment.htm 


More information about the development mailing list