From 70088cd22d842fd757d39150062e81c32e427dde Mon Sep 17 00:00:00 2001 From: Schuyler Eldridge Date: Wed, 18 Dec 2019 18:34:41 -0500 Subject: Improve Scaladoc (#1284) Signed-off-by: Schuyler Eldridge --- src/main/scala/firrtl/options/Phase.scala | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src') 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 -- cgit v1.2.3