Document Watchdog epochs better (#1345)

This commit is contained in:
Tyler Veness
2018-09-26 22:53:34 -07:00
committed by Peter Johnson
parent d5d744a390
commit 6171856020
2 changed files with 6 additions and 0 deletions

View File

@@ -51,6 +51,9 @@ class Watchdog {
/**
* Adds time since last epoch to the list printed by PrintEpochs().
*
* Epochs are a way to partition the time elapsed so that when overruns occur,
* one can determine which parts of an operation consumed the most time.
*
* @param epochName The name to associate with the epoch.
*/
void AddEpoch(wpi::StringRef epochName);