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/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;

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/snmp.inc.php

Doc Comments +19 added lines

@@ -26,6 +26,9 @@ 
 }//end string_to_oid()
 
 
+/**
+ * @param string $setting
+ */
 function prep_snmp_setting($device, $setting) {
     global $config;
 
@@ -46,6 +49,9 @@ 
 }//end mibdir()
 
 
+/**
+ * @param string $oids
+ */
 function snmp_get_multi($device, $oids, $options='-OQUs', $mib=null, $mibdir=null) {
     global $debug,$config,$runtime_stats,$mibs_loaded;
 
@@ -98,6 +104,9 @@ 
 }//end snmp_get_multi()
 
 
+/**
+ * @param string $options
+ */
 function snmp_get($device, $oid, $options=null, $mib=null, $mibdir=null) {
     global $debug,$config,$runtime_stats,$mibs_loaded;
 
@@ -152,6 +161,9 @@ 
 }//end snmp_get()
 
 
+/**
+ * @param string $options
+ */
 function snmp_walk($device, $oid, $options=null, $mib=null, $mibdir=null) {
     global $debug,$config,$runtime_stats;
 
@@ -973,6 +985,10 @@ 
  * Load the given MIB into the database.
  * @return count of objects loaded
  */
+/**
+ * @param string $mib
+ * @param string $module
+ */
 function snmp_mib_load($mib, $module, $included_by, $mibdir = null)
 {
     $mibs = array();
@@ -1265,6 +1281,9 @@ 
  * Validate MIBs and store the device->mib mapping in the database.
  * See includes/discovery/os/ruckuswireless.inc.php for an example of usage.
  */
+/**
+ * @param string $included_by
+ */
 function register_mibs($device, $mibs, $included_by)
 {
     if (!is_mib_poller_enabled($device)) {

includes/influxdb.inc.php

Doc Comments +3 added lines

@@ -41,6 +41,9 @@
 
 }// end influxdb_connect
 
+/**
+ * @param string $measurement
+ */
 function influx_update($device,$measurement,$tags=array(),$fields) {
     global $influxdb,$config,$console_color;
     $tmp_fields = array();

html/includes/authentication/ldap-authorization.inc.php

Doc Comments +9 added lines

@@ -253,6 +253,9 @@ 
 }
 
 
+/**
+ * @return string
+ */
 function get_membername ($username) {
     global $config, $ds;
     if ($config['auth_ldap_groupmembertype'] == 'fulldn') {
@@ -272,6 +275,9 @@ 
 }
 
 
+/**
+ * @param string $attr
+ */
 function auth_ldap_session_cache_get ($attr) {
     global $config;
 
@@ -297,6 +303,9 @@ 
 }
 
 
+/**
+ * @param string $attr
+ */
 function auth_ldap_session_cache_set ($attr, $value) {
     $_SESSION['auth_ldap'][$attr]['value'] = $value;
     $_SESSION['auth_ldap'][$attr]['last_updated'] = time ();

html/includes/authentication/ad-authorization.inc.php

Doc Comments +6 added lines

@@ -327,6 +327,9 @@ 
     return 'S-'.$revLevel.'-'.$authIdent.'-'.implode('-', $subAuths);
 }
 
+/**
+ * @param string $attr
+ */
 function auth_ldap_session_cache_get ($attr) {
     global $config;
 
@@ -352,6 +355,9 @@ 
 }
 
 
+/**
+ * @param string $attr
+ */
 function auth_ldap_session_cache_set ($attr, $value) {
     $_SESSION['auth_ldap'][$attr]['value'] = $value;
     $_SESSION['auth_ldap'][$attr]['last_updated'] = time ();