Index: includes/form.inc
===================================================================
RCS file: /cvs/drupal/drupal/includes/form.inc,v
retrieving revision 1.248
diff -u -p -r1.248 form.inc
--- includes/form.inc	23 Nov 2007 12:02:38 -0000	1.248
+++ includes/form.inc	25 Nov 2007 16:48:16 -0000
@@ -729,9 +729,16 @@ function form_execute_handlers($type, &$
 }
 
 /**
- * File an error against a form element. If the name of the element is
- * edit[foo][bar] then you may pass either foo or foo][bar as $name
- * foo will set an error for all its children.
+ * File an error against a form element.
+ *
+ * @param $name
+ *   The name of the form element. If the name of the element is
+ *   'edit[foo][bar]', then you may pass either 'foo' or 'foo][bar' as
+ *   $name. Passing 'foo' will set an error for all its children.
+ * @param $message
+ *   The error message to present to the user.
+ * @return
+ *   The original form with the indicated element(s) marked as error(s).
  */
 function form_set_error($name = NULL, $message = '') {
   static $form = array();