aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSchuyler Eldridge2019-12-18 18:34:41 -0500
committermergify[bot]2019-12-18 23:34:41 +0000
commit70088cd22d842fd757d39150062e81c32e427dde (patch)
tree0b377e77eac3b073b8694a6816682f3b7ff373b2 /src
parent1ba38df50bd04d098812774605b869a6c9b9cba8 (diff)
Improve Scaladoc (#1284)
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Diffstat (limited to 'src')
-rw-r--r--src/main/scala/firrtl/options/Phase.scala6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/main/scala/firrtl/options/Phase.scala b/src/main/scala/firrtl/options/Phase.scala
index 6a27e0da..e328282f 100644
--- a/src/main/scala/firrtl/options/Phase.scala
+++ b/src/main/scala/firrtl/options/Phase.scala
@@ -73,9 +73,9 @@ trait DependencyAPI[A <: DependencyAPI[A]] { this: TransformLike[_] =>
def dependents: Seq[Dependency] = Seq.empty
private[options] lazy val _dependents: LinkedHashSet[Dependency] = new LinkedHashSet() ++ dependents.toSet
- /** A function that, given a transform will return true if this transform invalidates/undos the effects of the input
- * transform
- * @note Can a [[firrtl.options.Phase Phase]] ever invalidate itself?
+ /** A function that, given *another* transform (parameter `a`) will return true if this transform invalidates/undos the
+ * effects of the *other* transform (parameter `a`).
+ * @param a transform
*/
def invalidates(a: A): Boolean = true