Merge pull request #547 from dawnbreak/docu

[TASK] Update Doxyfile and fix Doxygen errors.

1 files changed, 62 insertions, 41 deletions

diff --git a/include/help.php b/include/help.php
index 3081ae41f..f7fffc4d4 100644
--- a/include/help.php
+++ b/include/help.php
@@ -1,11 +1,17 @@
 <?php
 
+/**
+ * @brief
+ *
+ * @param string $tocpath
+ * @return string|unknown
+ */
 function get_help_content($tocpath = false) {
-	
+
 	global $lang;
-	
+
 	$doctype = 'markdown';
-	
+
 	$text = '';
 
 	$path = (($tocpath !== false) ? $tocpath : '');
@@ -25,7 +31,7 @@ function get_help_content($tocpath = false) {
 			\App::$page['title'] = t('Help:') . ' ' . ucwords(str_replace('-',' ',notags($title)));
 
 		$text = load_doc_file('doc/' . $path . '.md');
-	
+
 		if(! $text) {
 			$text = load_doc_file('doc/' . $path . '.bb');
 			if($text)
@@ -51,16 +57,16 @@ function get_help_content($tocpath = false) {
 			$text = load_doc_file('doc/main.bb');
 			\App::$page['title'] = t('Help');
 		}
-		
+
 		if(! $text) {
 			header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . t('Not Found'));
 			$tpl = get_markup_template("404.tpl");
 			return replace_macros($tpl, array(
-				'$message' =>  t('Page not found.' )
+				'$message' => t('Page not found.')
 			));
 		}
 	}
-	
+
 	if($doctype === 'html')
 		$content = $text;
 	if($doctype === 'markdown')	{
@@ -74,30 +80,30 @@ function get_help_content($tocpath = false) {
 		require_once('include/bbcode.php');
 		$content = bbcode($text);
 		// bbcode retargets external content to new windows. This content is internal.
-		$content = str_replace(' target="_blank"','',$content);		
-	} 
-	
+		$content = str_replace(' target="_blank"', '', $content);
+	}
+
 	$content = preg_replace_callback("/#include (.*?)\;/ism", 'preg_callback_help_include', $content);
+
 	return translate_projectname($content);
-	
 }
 
 function preg_callback_help_include($matches) {
-	
+
 	if($matches[1]) {
 		$include = str_replace($matches[0],load_doc_file($matches[1]),$matches[0]);
 		if(preg_match('/\.bb$/', $matches[1]) || preg_match('/\.txt$/', $matches[1])) {
 			require_once('include/bbcode.php');
 			$include = bbcode($include);
-			$include = str_replace(' target="_blank"','',$include);		
-		} 
+			$include = str_replace(' target="_blank"','',$include);
+		}
 		elseif(preg_match('/\.md$/', $matches[1])) {
 			require_once('library/markdown.php');
 			$include = Markdown($include);
 		}
 		return $include;
 	}
-	
+
 }
 
 
@@ -110,10 +116,10 @@ function load_doc_file($s) {
 	$d = dirname($s);
 
 	$c = find_doc_file("$d/$lang/$b");
-	if($c) 
+	if($c)
 		return $c;
 	$c = find_doc_file($s);
-	if($c) 
+	if($c)
 		return $c;
 	return '';
 }
@@ -125,6 +131,12 @@ function find_doc_file($s) {
 	return '';
 }
 
+/**
+ * @brief
+ *
+ * @param string $s
+ * @return number|mixed|unknown|boolean
+ */
 function search_doc_files($s) {
 
 	$itemspage = get_pconfig(local_channel(),'system','itemspage');
@@ -133,21 +145,21 @@ function search_doc_files($s) {
 
 	$regexop = db_getfunc('REGEXP');
 
-	$r = q("select iconfig.v, item.* from item left join iconfig on item.id = iconfig.iid 
+	$r = q("select iconfig.v, item.* from item left join iconfig on item.id = iconfig.iid
 		where iconfig.cat = 'system' and iconfig.k = 'docfile' and
 		body $regexop '%s' and item_type = %d $pager_sql",
 		dbesc($s),
 		intval(ITEM_TYPE_DOC)
 	);
-	
-	$r = fetch_post_tags($r,true);
+
+	$r = fetch_post_tags($r, true);
 
 	for($x = 0; $x < count($r); $x ++) {
 		$position =	stripos($r[$x]['body'], $s);
 		$dislen = 300;
 		$start = $position-floor($dislen/2);
 		if ( $start < 0) {
-				$start = 0;
+			$start = 0;
 		}
 		$r[$x]['text'] = substr($r[$x]['body'], $start, $dislen);
 
@@ -159,43 +171,50 @@ function search_doc_files($s) {
 				}
 			}
 		}
-		if(stristr($r[$x]['v'],$s))
+		if(stristr($r[$x]['v'], $s))
 			$r[$x]['rank'] ++;
-		$r[$x]['rank'] += substr_count(strtolower($r[$x]['text']),strtolower($s));
+		$r[$x]['rank'] += substr_count(strtolower($r[$x]['text']), strtolower($s));
 		// bias the results to the observer's native language
 		if($r[$x]['lang'] === \App::$language)
 			$r[$x]['rank'] = $r[$x]['rank'] + 10;
 
 	}
 	usort($r,'doc_rank_sort');
+
 	return $r;
 }
 
 
-function doc_rank_sort($s1,$s2) {
+function doc_rank_sort($s1, $s2) {
 	if($s1['rank'] == $s2['rank'])
 		return 0;
+
 	return (($s1['rank'] < $s2['rank']) ? 1 : (-1));
 }
 
-
+/**
+ * @brief
+ *
+ * @return string
+ */
 function load_context_help() {
-	
+
 	$path = App::$cmd;
 	$args = App::$argv;
 	$lang = App::$language;
-        
+
 	if(! isset($lang) || !is_dir('doc/context/' . $lang . '/')) {
-                $lang = 'en';
-        }
+		$lang = 'en';
+	}
 	while($path) {
 		$context_help = load_doc_file('doc/context/' . $lang . '/' . $path . '/help.html');
-                if(!$context_help) {
-                  // Fallback to English if the translation is absent
-                  $context_help = load_doc_file('doc/context/en/' . $path . '/help.html');
-                }
+		if(!$context_help) {
+			// Fallback to English if the translation is absent
+			$context_help = load_doc_file('doc/context/en/' . $path . '/help.html');
+		}
 		if($context_help)
 			break;
+
 		array_pop($args);
 		$path = implode($args,'/');
 	}
@@ -203,7 +222,12 @@ function load_context_help() {
 	return $context_help;
 }
 
-
+/**
+ * @brief
+ *
+ * @param string $s
+ * @return void|boolean[]|number[]|string[]|unknown[]
+ */
 function store_doc_file($s) {
 
 	if(is_dir($s))
@@ -215,10 +239,9 @@ function store_doc_file($s) {
 	$item['aid'] = 0;
 	$item['uid'] = $sys['channel_id'];
 
-
-	if(strpos($s,'.md'))
+	if(strpos($s, '.md'))
 		$mimetype = 'text/markdown';
-	elseif(strpos($s,'.html'))
+	elseif(strpos($s, '.html'))
 		$mimetype = 'text/html';
 	else
 		$mimetype = 'text/bbcode';
@@ -227,12 +250,12 @@ function store_doc_file($s) {
 
 	$item['body'] = html2plain(prepare_text(file_get_contents($s),$mimetype, true));
 	$item['mimetype'] = 'text/plain';
-	
+
 	$item['plink'] = z_root() . '/' . str_replace('doc','help',$s);
 	$item['owner_xchan'] = $item['author_xchan'] = $sys['channel_hash'];
 	$item['item_type'] = ITEM_TYPE_DOC;
 
-	$r = q("select item.* from item left join iconfig on item.id = iconfig.iid 
+	$r = q("select item.* from item left join iconfig on item.id = iconfig.iid
 		where iconfig.cat = 'system' and iconfig.k = 'docfile' and
 		iconfig.v = '%s' and item_type = %d limit 1",
 		dbesc($s),
@@ -252,6 +275,4 @@ function store_doc_file($s) {
 	}
 
 	return $x;
-
 }
-