Index: modules/filter/filter.module =================================================================== RCS file: /cvs/drupal/drupal/modules/filter/filter.module,v retrieving revision 1.204.2.9 diff -u -r1.204.2.9 filter.module --- modules/filter/filter.module 10 Aug 2009 11:04:37 -0000 1.204.2.9 +++ modules/filter/filter.module 23 Oct 2009 14:24:23 -0000 @@ -470,18 +470,23 @@ } /** - * Generate a selector for choosing a format in a form. + * Generates a selector for choosing a format in a form. + * + * @see filter_form_validate(). * - * @ingroup forms - * @see filter_form_validate() * @param $value - * The ID of the format that is currently selected. + * The ID of the format that is currently selected; uses the default format + * if not provided. * @param $weight - * The weight of the input format. + * The weight of the form element within the form. * @param $parents - * Required when defining multiple input formats on a single node or having a different parent than 'format'. + * The parents array of the element. Required when defining multiple text + * formats on a single form or having a different parent than 'format'. + * * @return - * HTML for the form element. + * Form API array for the form element. + * + * @ingroup forms */ function filter_form($value = FILTER_FORMAT_DEFAULT, $weight = NULL, $parents = array('format')) { $value = filter_resolve_format($value); @@ -528,6 +533,11 @@ return $form; } +/** + * Validation callback for filter elements in a form. + * + * @see filter_form(). + */ function filter_form_validate($form) { foreach (element_children($form) as $key) { if ($form[$key]['#value'] == $form[$key]['#return_value']) {