diff --git a/includes/form.inc b/includes/form.inc index f7fdda4384001efe5cd2c6745609245718a0fea1..6d562e57757d8278058cf501a062bc72e9ba9289 100644 --- a/includes/form.inc +++ b/includes/form.inc @@ -2,7 +2,26 @@ // $Id$ /** - * @defgroup form Form generation + * @defgroup forms Form builder functions + * @{ + * Functions that build an abstract representation of a HTML form. + * + * All modules should declare their form builder functions to be in this + * group and each builder function should reference its validate and submit + * functions using \@see. Conversely, validate and submit functions should + * reference the form builder function using \@see. For examples, of this see + * system_modules_uninstall() or user_pass(), the latter of which has the + * following in its doxygen documentation: + * + * \@ingroup forms + * \@see user_pass_validate(). + * \@see user_pass_submit(). + * + * @} End of "defgroup forms". + */ + +/** + * @defgroup form_api Form generation * @{ * Functions to enable the processing and display of HTML forms. * @@ -2205,7 +2224,7 @@ function form_clean_id($id = NULL, $flush = FALSE) { } /** - * @} End of "defgroup form". + * @} End of "defgroup form_api". */ /**