From b5e2bf119e91ec16b9df6eb35ff58b13390fecef Mon Sep 17 00:00:00 2001
From: cash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Sat, 19 Feb 2011 03:54:35 +0000
Subject: added documentation for the livesearch page handler

git-svn-id: http://code.elgg.org/elgg/trunk@8312 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/lib/input.php | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'engine/lib/input.php')

diff --git a/engine/lib/input.php b/engine/lib/input.php
index 0d34db8ae..cbc112772 100644
--- a/engine/lib/input.php
+++ b/engine/lib/input.php
@@ -197,9 +197,14 @@ function elgg_clear_sticky_value($form_name, $variable) {
 /**
  * Page handler for autocomplete endpoint.
  *
- * @param array $page Pages array
+ * /pg/livesearch/?q=<query>
  *
- * @return unknown_type
+ * Other options include:
+ *     match_on	   string all|array(groups|users|friends|subtype)
+ *     match_owner int    0/1
+ *     limit       int    default is 10
+ *
+ * @return string JSON string is returned and then exit
  */
 function input_livesearch_page_handler($page) {
 	global $CONFIG;
-- 
cgit v1.2.3