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/phase_fault_detection.hpp b/phosphor-regulators/src/phase_fault_detection.hpp
index 876d90e..6a84102 100644
--- a/phosphor-regulators/src/phase_fault_detection.hpp
+++ b/phosphor-regulators/src/phase_fault_detection.hpp
@@ -51,9 +51,9 @@
* hardware. Often a bit is checked in a status register. The status register
* could exist in the regulator or in a related I/O expander.
*
- * Phase fault detection is performed every 15 seconds. A phase fault must be
- * detected two consecutive times (15 seconds apart) before an error is logged.
- * This provides "de-glitching" to ignore transient hardware problems.
+ * Phase fault detection is executed repeatedly based on a timer. A phase fault
+ * must be detected two consecutive times before an error is logged. This
+ * provides "de-glitching" to ignore transient hardware problems.
*
* Phase faults are detected by executing actions.
*/