aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-02-09 18:05:04 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2010-02-09 18:05:04 +0000
commitb0fbcd6c2112abddd64188463d4482ced77de729 (patch)
tree27bb6312cc070290fe9d4be640340b6668fd59c8
parent7df61e9deb31debc1eadf6f2583299e49197c3e2 (diff)
downloadelgg-b0fbcd6c2112abddd64188463d4482ced77de729.tar.gz
elgg-b0fbcd6c2112abddd64188463d4482ced77de729.tar.bz2
Documentation correction in search.
git-svn-id: http://code.elgg.org/elgg/trunk@3925 36083f99-b078-4883-b0ff-0f9b5a30f544
-rw-r--r--mod/search/start.php11
1 files changed, 5 insertions, 6 deletions
diff --git a/mod/search/start.php b/mod/search/start.php
index 366ea4466..8a6f30e6b 100644
--- a/mod/search/start.php
+++ b/mod/search/start.php
@@ -77,11 +77,11 @@ function search_page_handler($page) {
* Return a string with highlighted matched queries and relevant context
* Determins context based upon occurance and distance of words with each other.
*
- * @param unknown_type $haystack
- * @param unknown_type $need
- * @param unknown_type $context
- * @param unknown_type $max_length
- * @return unknown_type
+ * @param string $haystack
+ * @param array $query
+ * @param int $min_match_context = 30
+ * @param int $max_length = 300
+ * @return string
*/
function search_get_highlighted_relevant_substrings($haystack, $query, $min_match_context = 30, $max_length = 300) {
global $CONFIG;
@@ -98,7 +98,6 @@ function search_get_highlighted_relevant_substrings($haystack, $query, $min_matc
return $return;
}
-
// get the starting positions and lengths for all matching words
$starts = array();
$lengths = array();