aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSchuyler Eldridge2020-06-02 20:29:32 -0400
committerGitHub2020-06-03 00:29:32 +0000
commit9bbdc1fc4462ba7d296443afe4b0fce78e10a410 (patch)
treeb803f2f31708cdff68e732afb408dbd42b2ab7e6 /src
parent77a471787b7ad688cfe7c1e518c11eaf31f2e182 (diff)
Scaladoc updates (#1656)
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Diffstat (limited to 'src')
-rw-r--r--src/main/scala/firrtl/annotations/Annotation.scala2
-rw-r--r--src/main/scala/firrtl/annotations/Target.scala2
2 files changed, 2 insertions, 2 deletions
diff --git a/src/main/scala/firrtl/annotations/Annotation.scala b/src/main/scala/firrtl/annotations/Annotation.scala
index fcbcdc96..c25ae5a6 100644
--- a/src/main/scala/firrtl/annotations/Annotation.scala
+++ b/src/main/scala/firrtl/annotations/Annotation.scala
@@ -90,7 +90,7 @@ trait SingleTargetAnnotation[T <: Named] extends Annotation {
/** [[MultiTargetAnnotation]] keeps the renamed targets grouped within a single annotation. */
trait MultiTargetAnnotation extends Annotation {
- /** Contains a sequence of targets.
+ /** Contains a sequence of [[firrtl.annotations.Target Target]].
* When created, [[targets]] should be assigned by `Seq(Seq(TargetA), Seq(TargetB), Seq(TargetC))`
*/
val targets: Seq[Seq[Target]]
diff --git a/src/main/scala/firrtl/annotations/Target.scala b/src/main/scala/firrtl/annotations/Target.scala
index f33a8fdf..c89d3120 100644
--- a/src/main/scala/firrtl/annotations/Target.scala
+++ b/src/main/scala/firrtl/annotations/Target.scala
@@ -649,7 +649,7 @@ case class InstanceTarget(circuit: String,
/** @return a [[ReferenceTarget]] referring to this declaration of this instance */
def asReference: ReferenceTarget = ReferenceTarget(circuit, module, path, instance, Nil)
- /** @return a [[ReferenceTarget]] referring to declaration of this ofModule */
+ /** @return a [[ModuleTarget]] referring to declaration of this ofModule */
def ofModuleTarget: ModuleTarget = ModuleTarget(circuit, ofModule)
override def circuitOpt: Option[String] = Some(circuit)