librenms / librenms

scripts/pre-commit.php

Doc Comments +1 added lines, -2 removed lines

@@ -184,7 +184,6 @@ 
  *  Check if the given options array contains any of the $opts specified
  *
  * @param array $options the array from getopt()
- * @param string $opts,... options to check for
  * @return bool If one of the specified options is set
  */
 function check_opt($options)
@@ -200,7 +199,7 @@ 
  * Build a list of exclude arguments from an array
  *
  * @param string $exclude_string such as "--exclude"
- * @param array $excludes array of directories to exclude
+ * @param string[] $excludes array of directories to exclude
  * @return string resulting string
  */
 function build_excludes($exclude_string, $excludes)

includes/device-groups.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
  * @param $pattern
  * @param $name
  * @param $desc
- * @return int|string
+ * @return integer|null
  */
 function AddDeviceGroup($name, $desc, $pattern)
 {

html/includes/collectd/functions.php

Doc Comments +3 added lines

@@ -446,6 +446,9 @@
 }//end _rrd_info()
 
 
+/**
+ * @param integer $code
+ */
 function rrd_get_color($code, $line = true)
 {
     global $config;

html/includes/graphs/device/collectd.inc.php

Doc Comments +6 added lines

@@ -22,6 +22,10 @@ 
 require 'includes/collectd/definitions.php';
 
 
+/**
+ * @param integer $fontsize
+ * @param integer $width
+ */
 function makeTextBlock($text, $fontfile, $fontsize, $width)
 {
     // TODO: handle explicit line-break!
@@ -49,6 +53,8 @@ 
  * @code_msg Short text description of HTTP error code
  * @title Title for fake RRD graph
  * @msg Complete error message to display in place of graph content
+ * @param integer $code
+ * @param string $code_msg
  */
 function error($code, $code_msg, $title, $msg)
 {

includes/billing.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
     return($cur_used/$since*$total);
 }
 
+/**
+ * @param string $inout
+ */
 function getValue($host, $port, $id, $inout)
 {
     global $config;

includes/influxdb.inc.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
     return($db);
 }// end influxdb_connect
 
+/**
+ * @param string $measurement
+ */
 function influx_update($device, $measurement, $tags, $fields)
 {
     global $influxdb, $config;

scripts/removespikes.php

Doc Comments +3 added lines

@@ -848,6 +848,9 @@
     }
 }
 
+/**
+ * @param string $string
+ */
 function debug($string)
 {
     global $debug;

html/includes/functions.inc.php

Doc Comments +19 added lines, -1 removed lines

@@ -162,6 +162,9 @@ 
 }//end generate_url()
 
 
+/**
+ * @param string $text
+ */
 function escape_quotes($text)
 {
     return str_replace('"', "\'", str_replace("'", "\'", $text));
@@ -301,6 +304,10 @@ 
 }//end generate_device_link()
 
 
+/**
+ * @param string $url
+ * @param string $class
+ */
 function overlib_link($url, $text, $contents, $class = null)
 {
     global $config;
@@ -535,6 +542,14 @@ 
 }//end generate_graph_js_state()
 
 
+/**
+ * @param integer $width
+ * @param integer $height
+ * @param string $left_colour
+ * @param string $right_text
+ * @param string $right_colour
+ * @param string $right_background
+ */
 function print_percentage_bar($width, $height, $percent, $left_text, $left_colour, $left_background, $right_text, $right_colour, $right_background)
 {
     if ($percent > '100') {
@@ -1052,6 +1067,9 @@ 
     }
 }
 
+/**
+ * @param string $string
+ */
 function shorten_interface_type($string)
 {
     return str_ireplace(
@@ -1412,7 +1430,7 @@ 
 
 /**
  * @param $data
- * @return bool|mixed
+ * @return string|false
  */
 function array_to_htmljson($data)
 {

includes/dbFacile.php

Doc Comments +8 added lines, -1 removed lines

@@ -156,6 +156,9 @@ 
  * */
 
 
+/**
+ * @param string $table
+ */
 function dbBulkInsert($data, $table)
 {
     $time_start = microtime(true);
@@ -205,6 +208,10 @@ 
  * */
 
 
+/**
+ * @param string $table
+ * @param string $where
+ */
 function dbUpdate($data, $table, $where = null, $parameters = array())
 {
     global $fullSql, $database_link;
@@ -565,7 +572,7 @@ 
  * Generate a string of placeholders to pass to fill in a list
  * result will look like this: (?, ?, ?, ?)
  *
- * @param $count
+ * @param integer $count
  * @return string placholder list
  */
 function dbGenPlaceholders($count)