@@ -184,7 +184,6 @@ discard block |
||
184 | 184 | * Check if the given options array contains any of the $opts specified |
185 | 185 | * |
186 | 186 | * @param array $options the array from getopt() |
187 | - * @param string $opts,... options to check for |
|
188 | 187 | * @return bool If one of the specified options is set |
189 | 188 | */ |
190 | 189 | function check_opt($options) |
@@ -200,7 +199,7 @@ discard block |
||
200 | 199 | * Build a list of exclude arguments from an array |
201 | 200 | * |
202 | 201 | * @param string $exclude_string such as "--exclude" |
203 | - * @param array $excludes array of directories to exclude |
|
202 | + * @param string[] $excludes array of directories to exclude |
|
204 | 203 | * @return string resulting string |
205 | 204 | */ |
206 | 205 | function build_excludes($exclude_string, $excludes) |
@@ -30,7 +30,7 @@ |
||
30 | 30 | * @param $pattern |
31 | 31 | * @param $name |
32 | 32 | * @param $desc |
33 | - * @return int|string |
|
33 | + * @return integer|null |
|
34 | 34 | */ |
35 | 35 | function AddDeviceGroup($name, $desc, $pattern) |
36 | 36 | { |
@@ -446,6 +446,9 @@ |
||
446 | 446 | }//end _rrd_info() |
447 | 447 | |
448 | 448 | |
449 | +/** |
|
450 | + * @param integer $code |
|
451 | + */ |
|
449 | 452 | function rrd_get_color($code, $line = true) |
450 | 453 | { |
451 | 454 | global $config; |
@@ -22,6 +22,10 @@ discard block |
||
22 | 22 | require 'includes/collectd/definitions.php'; |
23 | 23 | |
24 | 24 | |
25 | +/** |
|
26 | + * @param integer $fontsize |
|
27 | + * @param integer $width |
|
28 | + */ |
|
25 | 29 | function makeTextBlock($text, $fontfile, $fontsize, $width) |
26 | 30 | { |
27 | 31 | // TODO: handle explicit line-break! |
@@ -49,6 +53,8 @@ discard block |
||
49 | 53 | * @code_msg Short text description of HTTP error code |
50 | 54 | * @title Title for fake RRD graph |
51 | 55 | * @msg Complete error message to display in place of graph content |
56 | + * @param integer $code |
|
57 | + * @param string $code_msg |
|
52 | 58 | */ |
53 | 59 | function error($code, $code_msg, $title, $msg) |
54 | 60 | { |
@@ -73,6 +73,9 @@ |
||
73 | 73 | return($cur_used/$since*$total); |
74 | 74 | } |
75 | 75 | |
76 | +/** |
|
77 | + * @param string $inout |
|
78 | + */ |
|
76 | 79 | function getValue($host, $port, $id, $inout) |
77 | 80 | { |
78 | 81 | global $config; |
@@ -38,6 +38,9 @@ |
||
38 | 38 | return($db); |
39 | 39 | }// end influxdb_connect |
40 | 40 | |
41 | +/** |
|
42 | + * @param string $measurement |
|
43 | + */ |
|
41 | 44 | function influx_update($device, $measurement, $tags, $fields) |
42 | 45 | { |
43 | 46 | global $influxdb, $config; |
@@ -848,6 +848,9 @@ |
||
848 | 848 | } |
849 | 849 | } |
850 | 850 | |
851 | +/** |
|
852 | + * @param string $string |
|
853 | + */ |
|
851 | 854 | function debug($string) |
852 | 855 | { |
853 | 856 | global $debug; |
@@ -162,6 +162,9 @@ discard block |
||
162 | 162 | }//end generate_url() |
163 | 163 | |
164 | 164 | |
165 | +/** |
|
166 | + * @param string $text |
|
167 | + */ |
|
165 | 168 | function escape_quotes($text) |
166 | 169 | { |
167 | 170 | return str_replace('"', "\'", str_replace("'", "\'", $text)); |
@@ -301,6 +304,10 @@ discard block |
||
301 | 304 | }//end generate_device_link() |
302 | 305 | |
303 | 306 | |
307 | +/** |
|
308 | + * @param string $url |
|
309 | + * @param string $class |
|
310 | + */ |
|
304 | 311 | function overlib_link($url, $text, $contents, $class = null) |
305 | 312 | { |
306 | 313 | global $config; |
@@ -535,6 +542,14 @@ discard block |
||
535 | 542 | }//end generate_graph_js_state() |
536 | 543 | |
537 | 544 | |
545 | +/** |
|
546 | + * @param integer $width |
|
547 | + * @param integer $height |
|
548 | + * @param string $left_colour |
|
549 | + * @param string $right_text |
|
550 | + * @param string $right_colour |
|
551 | + * @param string $right_background |
|
552 | + */ |
|
538 | 553 | function print_percentage_bar($width, $height, $percent, $left_text, $left_colour, $left_background, $right_text, $right_colour, $right_background) |
539 | 554 | { |
540 | 555 | if ($percent > '100') { |
@@ -1052,6 +1067,9 @@ discard block |
||
1052 | 1067 | } |
1053 | 1068 | } |
1054 | 1069 | |
1070 | +/** |
|
1071 | + * @param string $string |
|
1072 | + */ |
|
1055 | 1073 | function shorten_interface_type($string) |
1056 | 1074 | { |
1057 | 1075 | return str_ireplace( |
@@ -1412,7 +1430,7 @@ discard block |
||
1412 | 1430 | |
1413 | 1431 | /** |
1414 | 1432 | * @param $data |
1415 | - * @return bool|mixed |
|
1433 | + * @return string|false |
|
1416 | 1434 | */ |
1417 | 1435 | function array_to_htmljson($data) |
1418 | 1436 | { |
@@ -156,6 +156,9 @@ discard block |
||
156 | 156 | * */ |
157 | 157 | |
158 | 158 | |
159 | +/** |
|
160 | + * @param string $table |
|
161 | + */ |
|
159 | 162 | function dbBulkInsert($data, $table) |
160 | 163 | { |
161 | 164 | $time_start = microtime(true); |
@@ -205,6 +208,10 @@ discard block |
||
205 | 208 | * */ |
206 | 209 | |
207 | 210 | |
211 | +/** |
|
212 | + * @param string $table |
|
213 | + * @param string $where |
|
214 | + */ |
|
208 | 215 | function dbUpdate($data, $table, $where = null, $parameters = array()) |
209 | 216 | { |
210 | 217 | global $fullSql, $database_link; |
@@ -565,7 +572,7 @@ discard block |
||
565 | 572 | * Generate a string of placeholders to pass to fill in a list |
566 | 573 | * result will look like this: (?, ?, ?, ?) |
567 | 574 | * |
568 | - * @param $count |
|
575 | + * @param integer $count |
|
569 | 576 | * @return string placholder list |
570 | 577 | */ |
571 | 578 | function dbGenPlaceholders($count) |