From 82da362037a227a1c16eb56ead69f3f73cea6c4f Mon Sep 17 00:00:00 2001
From: chick
Date: Wed, 10 Feb 2016 12:11:51 -0800
Subject: Added some comments describing potential use of the finish method
 hook clean up the test example

---
 src/main/scala/Chisel/testers/BasicTester.scala | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/main')

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 = {}
 }
-- 
cgit v1.2.3