From db581c08d0cb9d37a3bba17cf987077f16cf7ba2 Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Thu, 14 Apr 2016 17:05:19 +0200
Subject: [PATCH] rework autocomplete: some polishing

---
 include/DirSearch.php     | 6 ++++--
 include/Smilies.php       | 6 ++++--
 include/acl_selectors.php | 4 ++--
 include/network.php       | 2 +-
 mod/smilies.php           | 2 +-
 5 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/include/DirSearch.php b/include/DirSearch.php
index a6a0b59fcb..8682cb18ef 100644
--- a/include/DirSearch.php
+++ b/include/DirSearch.php
@@ -1,7 +1,8 @@
 <?php
 
 /**
- * @file include/dir.php
+ * @file include/DirSearch.php
+ * @brief This file includes the DirSearch class with directory related functions
  */
 
 
@@ -15,7 +16,7 @@ class DirSearch {
 	 *  * 
 	 * @param string $search Name or nick
 	 * @param string $mode Search mode 
-	 * @return array
+	 * @return array with search results
 	 */
 	public static function global_search_by_name($search, $mode = '') {
 
@@ -51,6 +52,7 @@ class DirSearch {
 						intval(local_user()), dbesc(CONTACT_IS_SHARING), dbesc(CONTACT_IS_FRIEND),
 						dbesc(NETWORK_DFRN), dbesc($ostatus), dbesc($diaspora),
 						dbesc(escape_tags($search)), dbesc(escape_tags($search)));
+
 			return $results;
 		}
 
diff --git a/include/Smilies.php b/include/Smilies.php
index 193f3b555d..d7a51180cd 100644
--- a/include/Smilies.php
+++ b/include/Smilies.php
@@ -121,7 +121,7 @@ class Smilies {
 	 * @param string $s
 	 * @param boolean $sample
 	 * 
-	 * @return string
+	 * @return string HML Output of the Smilie
 	 */
 	public static function replace($s, $sample = false) {
 		if(intval(get_config('system','no_smilies'))
@@ -164,7 +164,9 @@ class Smilies {
 	 * @brief expand <3333 to the correct number of hearts
 	 *
 	 * @param string $x
-	 * @return string
+	 * @return string HTML Output
+	 * 
+	 * @todo: Rework because it doesn't work correctly
 	 */
 	private function preg_heart($x) {
 		if(strlen($x[1]) == 1)
diff --git a/include/acl_selectors.php b/include/acl_selectors.php
index 4a35fd0f08..47f97250f8 100644
--- a/include/acl_selectors.php
+++ b/include/acl_selectors.php
@@ -663,7 +663,7 @@ function acl_lookup(&$a, $out_type = 'json') {
  * @brief Searching for global contacts for autocompletion
  * 
  * @param App $a
- * @return array
+ * @return array with the search results
  */
 function navbar_complete(&$a) {
 
@@ -704,4 +704,4 @@ function navbar_complete(&$a) {
 		}
 	}
 	return;
-}
\ No newline at end of file
+}
diff --git a/include/network.php b/include/network.php
index 5fd73bfef9..8e076aa600 100644
--- a/include/network.php
+++ b/include/network.php
@@ -1294,7 +1294,7 @@ function short_link($url) {
  * and adds an application/json HTTP header to the output.
  * After finishing the process is getting killed.
  * 
- * @param array $x
+ * @param array $x The input content
  */
 function json_return_and_die($x) {
 	header("content-type: application/json");
diff --git a/mod/smilies.php b/mod/smilies.php
index b3d86cb3fe..573cf17c8a 100644
--- a/mod/smilies.php
+++ b/mod/smilies.php
@@ -16,6 +16,6 @@ function smilies_content(&$a) {
 		json_return_and_die($results);
 	}
 	else {
-		return smilies('',true);
+		return Smilies::replace('',true);
 	}
 }