From: scyrma <scyrma>
Date: Tue, 18 Dec 2007 08:39:44 +0000 (+0000)
Subject: Add some documentation
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=5cce2e75120495e139771c0987486b55f6098c22;p=moodle.git

Add some documentation
---

diff --git a/mod/forum/search.php b/mod/forum/search.php
index 75e311a260..833ac31a0c 100644
--- a/mod/forum/search.php
+++ b/mod/forum/search.php
@@ -359,7 +359,13 @@ function forum_print_big_search_form($course) {
 }
 
 /**
- * @todo Document this function
+ * This function takes each word out of the search string, makes sure they are at least 
+ * two characters long and returns an array containing every good word.
+ * 
+ * @param string $words String containing space-separated strings to search for
+ * @param string $prefix String to prepend to the each token taken out of $words
+ * @returns array 
+ * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter
  */
 function forum_clean_search_terms($words, $prefix='') {
     $searchterms = explode(' ', $words);