From a4623f1f713ca3e23c8cbe7b9090f5642ff72363 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Sat, 13 Jun 2009 19:37:27 +0000
Subject: - Patch #480152 by jhodgdon: updated filter API documentation.

---
 modules/filter/filter.module | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/modules/filter/filter.module b/modules/filter/filter.module
index 41df662b2..f2bb71634 100644
--- a/modules/filter/filter.module
+++ b/modules/filter/filter.module
@@ -598,13 +598,20 @@ function theme_filter_guidelines($format) {
  */
 
 /**
- * Implement hook_filter(). Contains a basic set of essential filters.
- * - HTML filter:
- *     Validates user-supplied HTML, transforming it as necessary.
- * - Line break converter:
- *     Converts newlines into paragraph and break tags.
- * - URL and e-mail address filter:
+ * Implement hook_filter().
+ *  
+ * Set up a basic set of essential filters:
+ * - Limit allowed HTML tags:
+ *     Restricts user-supplied HTML to certain tags, and removes dangerous
+ *     components in allowed tags.
+ * - Convert line breaks:
  *     Converts newlines into paragraph and break tags.
+ * - Convert URLs into links:
+ *     Converts URLs and e-mail addresses into links.
+ * - Correct broken HTML:
+ *     Fixes faulty HTML.
+ * - Escape all HTML:
+ *     Converts all HTML tags into visible text.
  */
 function filter_filter($op, $delta = 0, $format = -1, $text = '') {
   switch ($op) {
-- 
cgit v1.2.3