diff --git a/includes/form.inc b/includes/form.inc index e684bd2f702e2d55406accb7eb7bd7e41b095f8d..be16c0f2e9ac4d06cfeed507128b4aff6b008955 100644 --- a/includes/form.inc +++ b/includes/form.inc @@ -248,9 +248,14 @@ function form_get_cache($form_build_id, &$form_state) { } /** - * Retrieves a form using a form_id, populates it with $form_state['values'], - * processes it, and returns any validation errors encountered. This - * function is the programmatic counterpart to drupal_get_form(). + * Retrieves, populates, and processes a form. + * + * This function allows you to supply values for form elements and submit a + * form for processing. Compare to drupal_get_form(), which also builds and + * processes a form, but does not allow you to supply values. + * + * There is no return value, but you can check to see if there are errors by + * calling form_get_errors(). * * @param $form_id * The unique string identifying the desired form. If a function @@ -270,7 +275,6 @@ function form_get_cache($form_build_id, &$form_state) { * For example, the node_edit form requires that a node object be passed * in here when it is called. * For example: - * * @code * // register a new user * $form_state = array();