aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/main/scala/firrtl/options/Exceptions.scala2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/main/scala/firrtl/options/Exceptions.scala b/src/main/scala/firrtl/options/Exceptions.scala
index 38b2f2e2..3773e156 100644
--- a/src/main/scala/firrtl/options/Exceptions.scala
+++ b/src/main/scala/firrtl/options/Exceptions.scala
@@ -11,6 +11,8 @@ class PhaseException(val message: String, cause: Throwable = null) extends Runti
/** Indicate an error related to a bad [[firrtl.annotations.Annotation Annotation]] or it's command line option
* equivalent. This exception is always caught and converted to an error message by a [[Stage]]. Do not use this for
* communicating generic exception information.
+ * @param message exception message [[scala.Predef.String String]]
+ * @param cause the reason for this exception (a Java [[java.lang.Throwable Throwable]])
*/
class OptionsException(val message: String, cause: Throwable = null) extends IllegalArgumentException(message, cause)