librenms / librenms

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/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)
 {

LibreNMS/OS/Arubaos.php

Doc Comments +5 added lines, -1 removed lines

@@ -46,7 +46,7 @@ 
      * Discover wireless client counts. Type is clients.
      * Returns an array of LibreNMS\Device\Sensor objects that have been discovered
      *
-     * @return array Sensors
+     * @return WirelessSensor[] Sensors
      */
     public function discoverWirelessClients()
     {
@@ -97,6 +97,10 @@ 
         return $channel & 255; // mask off the channel width information
     }
 
+    /**
+     * @param string $type
+     * @param string $oid
+     */
     private function discoverInstantRadio($type, $oid, $desc = 'Radio %s')
     {
         $data = snmpwalk_cache_oid_num($this->getDevice(), $oid, array(), 'AI-AP-MIB');

includes/alerts.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -26,7 +26,7 @@ 
 /**
  * Generate SQL from Rule
  * @param string $rule Rule to generate SQL for
- * @return string|boolean
+ * @return false|string
  */
 function GenSQL($rule)
 {
@@ -147,7 +147,7 @@ 
 /**
  * Run all rules for a device
  * @param int $device Device-ID
- * @return void
+ * @return false|null
  */
 function RunRules($device)
 {
@@ -425,7 +425,7 @@ 
  * "Safely" run eval
  * @param string $code Code to run
  * @param array  $obj  Object with variables
- * @return string|mixed
+ * @return string
  */
 function RunJail($code, $obj)
 {

LibreNMS/IRCBot.php

Doc Comments +24 added lines

@@ -208,6 +208,11 @@ 
     }//end connect_alert()
 
 
+    /**
+     * @param string $buff
+     *
+     * @return string
+     */
     private function read($buff)
     {
         $r                  = fread($this->socket[$buff], 64);
@@ -381,6 +386,10 @@ 
     }//end handleCommand()
 
 
+    /**
+     * @param string $command
+     * @param string $params
+     */
     private function proceedCommand($command, $params)
     {
         $command = strtolower($command);
@@ -405,6 +414,9 @@ 
     }//end respond()
 
 
+    /**
+     * @param string $param
+     */
     private function getChan($param)
     {
         $data = explode('PRIVMSG ', $this->data, 3);
@@ -419,6 +431,11 @@ 
         return str_replace(':', '', $arrData[0]);
     }//end getUser()
 
+    /**
+     * @param string $param
+     *
+     * @return string
+     */
     private function getUserHost($param)
     {
         $arrData = explode(' ', $param, 2);
@@ -564,6 +581,9 @@ 
     }//end hostAuth
 
 
+    /**
+     * @param string $params
+     */
     private function ircRaw($params)
     {
         return fputs($this->socket['irc'], $params."\r\n");
@@ -869,6 +889,10 @@ 
         return $this->respond($msg);
     }//end _status()
 
+    /**
+     * @param string $fg_color
+     * @param string $other
+     */
     private function _color($text, $fg_color, $bg_color = null, $other = null)
     {
         $colors = array(