librenms / librenms

includes/common.php

Doc Comments +23 added lines

@@ -16,6 +16,10 @@ 
  * the source code distribution for details.
  */
 
+/**
+ * @param double $number
+ * @param string $sf
+ */
 function format_number_short($number, $sf) {
     // This formats a number so that we only send back three digits plus an optional decimal point.
     // Example: 723.42 -> 723    72.34 -> 72.3    2.23 -> 2.23
@@ -32,6 +36,9 @@ 
     return $number;
 }
 
+/**
+ * @param string $command
+ */
 function external_exec($command) {
     d_echo($command."\n");
     $output = shell_exec($command);
@@ -396,6 +403,9 @@ 
     return $os;
 }
 
+/**
+ * @return string
+ */
 function safename($name) {
     return preg_replace('/[^a-zA-Z0-9,._\-]/', '_', $name);
 }
@@ -450,6 +460,9 @@ 
     }
 }
 
+/**
+ * @param string $attrib
+ */
 function is_dev_attrib_enabled($device, $attrib, $default = true) {
     $val = get_dev_attrib($device, $attrib);
     if ($val != NULL) {
@@ -767,6 +780,9 @@ 
 } // count_mib_health
 
 
+/**
+ * @param string $oid
+ */
 function get_mibval($device, $oid)
 {
     $sql = 'SELECT * FROM `device_oids` WHERE `device_id` = ? AND `oid` = ?';
@@ -904,6 +920,10 @@ 
 /*
  * @return true if the requested module type & name is globally enabled
  */
+/**
+ * @param string $type
+ * @param string $module
+ */
 function is_module_enabled($type, $module)
 {
     global $config;
@@ -919,6 +939,9 @@ 
 /*
  * @return true if every string in $arr begins with $str
  */
+/**
+ * @param string $str
+ */
 function begins_with($str, $arr)
 {
     foreach ($arr as $s) {