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)

tests/mocks/mock.snmp.inc.php

Doc Comments +7 added lines

@@ -200,6 +200,10 @@ 
 
 // Mocked functions
 
+/**
+ * @param string $options
+ * @param string $mib
+ */
 function snmp_get($device, $oid, $options = null, $mib = null, $mibdir = null)
 {
     $community = $device['community'];
@@ -222,6 +226,9 @@ 
     }
 }
 
+/**
+ * @param string $options
+ */
 function snmp_walk($device, $oid, $options = null, $mib = null, $mibdir = null)
 {
     $community = $device['community'];

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/authentication/ad-authorization.inc.php

Doc Comments +6 added lines

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

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

Doc Comments +9 added lines

@@ -272,6 +272,9 @@ 
 }
 
 
+/**
+ * @return string
+ */
 function get_membername($username)
 {
     global $config, $ldap_connection;
@@ -290,6 +293,9 @@ 
 }
 
 
+/**
+ * @param string $attr
+ */
 function auth_ldap_session_cache_get($attr)
 {
     global $config;
@@ -320,6 +326,9 @@ 
 }
 
 
+/**
+ * @param string $attr
+ */
 function auth_ldap_session_cache_set($attr, $value)
 {
     $_SESSION['auth_ldap'][$attr]['value'] = $value;

html/includes/authentication/ldap.inc.php

Doc Comments +3 added lines

@@ -206,6 +206,9 @@
 }
 
 
+/**
+ * @return string
+ */
 function get_membername($username)
 {
     global $config, $ldap_connection;

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;