Added some comments describing potential use of the finish method hook

clean up the test example

1 files changed, 5 insertions, 0 deletions

diff --git a/src/main/scala/Chisel/testers/BasicTester.scala b/src/main/scala/Chisel/testers/BasicTester.scala
index 98033486..8f4d60f4 100644
--- a/src/main/scala/Chisel/testers/BasicTester.scala
+++ b/src/main/scala/Chisel/testers/BasicTester.scala
@@ -25,5 +25,10 @@ class BasicTester extends Module {
     }
   }
 
+  /** Called this class or a subclass's constructor has finished giving
+    * developers of chisel testers a post construction hook.
+    * For example, a decoupled tester subclassing BasicTester could override finish in order to
+    * add flow control logic around loading the device under test's input io from a Vec of values
+    */
   def finish(): Unit = {}
 }