maketank/Froxlor
2
0
Fork 0
Code Pull Requests Releases Activity

show basic api doc in webinterface (top-menu - options - API help)

Browse Source 
Signed-off-by: Michael Kaufmann (d00p) <d00p@froxlor.org>
This commit is contained in:
Michael Kaufmann (d00p)
2018-02-22 13:41:28 +01:00
parent a468fe50df
commit b42a7b1b26
9 changed files with 171 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
lib/classes/api/commands/class.Froxlor.php
View File

@@ -20,7 +20,7 @@ class Froxlor extends ApiCommand
/**
* checks whether there is a newer version of froxlor available
*
*
* @throws Exception
* @return string
*/
@@ -178,6 +178,7 @@ class Froxlor extends ApiCommand
$clines = explode("\n", $comment);
$result = array();
$result['params'] = array();
$param_desc = false;
foreach ($clines as $c) {
$c = trim($c);
// check param-section
@@ -189,6 +190,7 @@ class Froxlor extends ApiCommand
'type' => $r[1],
'desc' => (isset($r[3]) ? trim($r['3']) : '')
);
$param_desc = true;
} // check return-section
elseif (strpos($c, '@return')) {
preg_match('/^\*\s\@return\s(\w+)(\s.*)?/', $c, $r);
@@ -201,18 +203,26 @@ class Froxlor extends ApiCommand
'desc' => (isset($r[2]) ? trim($r[2]) : '')
);
} else if (! empty($c) && strpos($c, '@throws') === false) {
if (substr($c, 0, 3) == "/**")
if (substr($c, 0, 3) == "/**") {
continue;
if (substr($c, 0, 2) == "*/")
}
if (substr($c, 0, 2) == "*/") {
continue;
if (substr($c, 0, 1) == "*")
}
if (substr($c, 0, 1) == "*") {
$c = trim(substr($c, 1));
if (empty($c))
continue;
if (! isset($result['head']) || empty($result['head'])) {
$result['head'] = $c . " ";
} else {
$result['head'] .= $c . " ";
if (empty($c)) {
continue;
}
if ($param_desc) {
$result['params'][count($result['params']) - 1]['desc'] .= $c;
} else {
if (! isset($result['head']) || empty($result['head'])) {
$result['head'] = $c . " ";
} else {
$result['head'] .= $c . " ";
}
}
}
}
}