librenms / librenms

alerts.php

Doc Comments +1 added lines, -1 removed lines

@@ -522,7 +522,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) {
     $ret = '';

html/includes/authentication/ldap.inc.php

Doc Comments +3 added lines

@@ -202,6 +202,9 @@
 }
 
 
+/**
+ * @return string
+ */
 function get_membername($username) {
     global $config, $ds;
     if ($config['auth_ldap_groupmembertype'] == 'fulldn') {

html/includes/collectd/functions.php

Doc Comments +6 added lines, -1 removed lines

@@ -277,7 +277,7 @@ 
  * @pinst Plugin instance
  * @type Type name
  * @tinst Type instance
- * @return Identifier that collectd's FLUSH command understands
+ * @return string that collectd's FLUSH command understands
  */
 function collectd_identifier($host, $plugin, $pinst, $type, $tinst) {
     global $config;
@@ -477,6 +477,7 @@ 
 /**
  * Helper function to strip quotes from RRD output
  * @str RRD-Info generated string
+ * @param string $str
  * @return String with one surrounding pair of quotes stripped
  */
 function rrd_strip_quotes($str) {
@@ -493,6 +494,7 @@ 
 /**
  * Determine useful information about RRD file
  * @file Name of RRD file to analyse
+ * @param string $file
  * @return Array describing the RRD file
  */
 function rrd_info($file) {
@@ -557,6 +559,9 @@ 
 }//end rrd_info()
 
 
+/**
+ * @param integer $code
+ */
 function rrd_get_color($code, $line=true) {
     global $config;
     $name = ($line ? 'f_' : 'h_').$code;

html/includes/functions.inc.php

Doc Comments +15 added lines

@@ -276,6 +276,10 @@ 
 }//end generate_device_link()
 
 
+/**
+ * @param string $url
+ * @param string|null $class
+ */
 function overlib_link($url, $text, $contents, $class) {
     global $config;
 
@@ -505,6 +509,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') {
         $size_percent = '100';
@@ -1022,6 +1034,9 @@ 
 }//end get_client_ip()
 
 
+/**
+ * @param string $string
+ */
 function shorten_interface_type($string) {
     return str_ireplace(
         array(

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!
     $words       = explode(' ', $text);
@@ -50,6 +54,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) {
     global $config;

html/includes/PasswordHash.php

Doc Comments +19 added lines

@@ -30,6 +30,10 @@ 
 	var $portable_hashes;
 	var $random_state;
 
+	/**
+	 * @param integer $iteration_count_log2
+	 * @param boolean $portable_hashes
+	 */
 	function PasswordHash($iteration_count_log2, $portable_hashes)
 	{
 		$this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
@@ -45,6 +49,9 @@ 
 			$this->random_state .= getmypid();
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	function get_random_bytes($count)
 	{
 		$output = openssl_random_pseudo_bytes($count,$strong);
@@ -73,6 +80,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	function encode64($input, $count)
 	{
 		$output = '';
@@ -96,6 +106,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_private($input)
 	{
 		$output = '$P$';
@@ -151,6 +164,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_extended($input)
 	{
 		$count_log2 = min($this->iteration_count_log2 + 8, 24);
@@ -169,6 +185,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_blowfish($input)
 	{
 		# This one needs to use a different order of characters and a

includes/billing.php

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
 }//end getDates()
 
 
+/**
+ * @param string $inout
+ */
 function getValue($host, $port, $id, $inout) {
     global $config;
 

includes/object-cache.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
     /**
      * Reset Data-Object
      * @param string $obj Name of Data-Object
-     * @return mixed
+     * @return boolean
      */
     public function offsetUnset($obj) {
         unset($this->data[$obj]['value']);

includes/rrdtool.inc.php

Doc Comments +7 added lines, -1 removed lines

@@ -14,7 +14,7 @@ 
 /**
  * Opens up a pipe to RRDTool using handles provided
  *
- * @return boolean
+ * @return boolean|null
  * @global config
  * @global debug
  * @param  &rrd_process
@@ -70,6 +70,7 @@ 
  * @return integer
  * @param  resource rrd_process
  * @param  array rrd_pipes
+ * @param resource $rrd_process
  */
 
 
@@ -97,6 +98,7 @@ 
  * @return integer
  * @param  string graph_file
  * @param  string options
+ * @param string $options
  */
 
 
@@ -157,6 +159,7 @@ 
  * @param  string command
  * @param  string filename
  * @param  string options
+ * @param string $command
  * @global config
  * @global debug
  * @global rrd_pipes
@@ -202,6 +205,8 @@ 
  *
  * @param string filename
  * @param string options
+ * @param string $filename
+ * @param string $options
  */
 
 
@@ -223,6 +228,7 @@ 
  *
  * @param string filename
  * @param array options
+ * @param string $filename
  */