Clarify chiselTests.Utils.extractCause Scaladoc

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

1 files changed, 11 insertions, 3 deletions

diff --git a/src/test/scala/chiselTests/ChiselSpec.scala b/src/test/scala/chiselTests/ChiselSpec.scala
index 04c35f32..2ee6fbcf 100644
--- a/src/test/scala/chiselTests/ChiselSpec.scala
+++ b/src/test/scala/chiselTests/ChiselSpec.scala
@@ -270,11 +270,19 @@ trait Utils {
     }
   }
 
-  /** Run some code extracting an exception cause that matches a type parameter
+  /** Run some code and rethrow an exception with a specific type if an exception of that type occurs anywhere in the
+    * stack trace.
+    *
+    * This is useful for "extracting" one exception that may be wrapped by other exceptions.
+    *
+    * Example usage:
+    * {{{
+    * a [ChiselException] should be thrownBy extractCause[ChiselException] { /* ... */ }
+    * }}}
+    *
     * @param thunk some code to run
-    * @tparam A the type of the exception to expect
+    * @tparam A the type of the exception to extract
     * @return nothing
-    * @throws the exception of type parameter A if it was found
     */
   def extractCause[A <: Throwable : ClassTag](thunk: => Any): Unit = {
     def unrollCauses(a: Throwable): Seq[Throwable] = a match {