regulators: Remove monitoring freq from comments
Update doxygen comments to remove the exact frequency of sensor
monitoring and phase fault detection.
Currently sensors are monitored every second and phase faults are
detected every 15 seconds. However, that could change in the future.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I3ac39955721fde98dfe9e6059693ceeea7e504c2
diff --git a/phosphor-regulators/src/device.hpp b/phosphor-regulators/src/device.hpp
index af0e8ec..352daeb 100644
--- a/phosphor-regulators/src/device.hpp
+++ b/phosphor-regulators/src/device.hpp
@@ -137,7 +137,7 @@
*
* Does nothing if phase fault detection is not defined for this device.
*
- * This method should be called every 15 seconds.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains the chassis
@@ -255,7 +255,7 @@
* Monitors the sensors for the voltage rails produced by this device, if
* any.
*
- * This method should be called once per second.
+ * This method should be called repeatedly based on a timer.
*
* @param services system services like error logging and the journal
* @param system system that contains the chassis