Index: formfilter.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/formfilter/formfilter.module,v retrieving revision 1.7 diff -u -F^function -r1.7 formfilter.module --- formfilter.module 7 May 2008 17:17:30 -0000 1.7 +++ formfilter.module 2 Nov 2008 21:11:29 -0000 @@ -10,6 +10,18 @@ function formfilter_supported_types() { /** * Filter a form so the requested elements are invisible (passed as values). + * + * @param $form + * A reference to the form to be altered. + * @param $filters + * An array of elements to make invisibile in the form, each element in turn being + * an array of form keys corresponding to the path of the element in the form + * structure. For example, to hide the element $form['comment_filter']['format'] + * from $form, you could call this function as follows: + * formfilter_filter_form($form, array(array('comment_filter', 'format'))); + * @param $inverse + * If TRUE, all elements excepts the ones given in $filters will become + * invisible. This defaults to FALSE. */ function formfilter_filter_form(&$form, $filters, $inverse = FALSE) { // Iterate through filters.