diff options
| author | Gábor Hojtsy <gabor@hojtsy.hu> | 2008-01-21 15:17:01 +0000 |
|---|---|---|
| committer | Gábor Hojtsy <gabor@hojtsy.hu> | 2008-01-21 15:17:01 +0000 |
| commit | fe65a869fa924d84e7ac5bac06a48432929f1047 (patch) | |
| tree | 6e8f0368410d9431a9004d8b7cd380560a02ee63 | |
| parent | d5823e8673b1e00708242be625e31008cf4a55c5 (diff) | |
| download | brdo-fe65a869fa924d84e7ac5bac06a48432929f1047.tar.gz brdo-fe65a869fa924d84e7ac5bac06a48432929f1047.tar.bz2 | |
#195283 by pwolanin: code documentation for the 'forms' function group
| -rw-r--r-- | includes/form.inc | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/includes/form.inc b/includes/form.inc index f7fdda438..6d562e577 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". */ /** |