Commit fe65a869 authored by Gábor Hojtsy's avatar Gábor Hojtsy
Browse files

#195283 by pwolanin: code documentation for the 'forms' function group

parent d5823e86
......@@ -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".
*/
/**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment