summaryrefslogtreecommitdiff
path: root/chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala
diff options
context:
space:
mode:
authorJack Koenig2017-12-13 20:23:13 -0800
committeredwardcwang2017-12-13 22:09:55 -0800
commitb657a2d5de6d53d5ce7da28908c89773e35083a8 (patch)
tree424c44f92546df07df99b1b60a71db123450ce02 /chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala
parent66f958d5b856b1633e18c567bb0f838c2291f4f6 (diff)
Fix some ScalaDoc warnings
Diffstat (limited to 'chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala')
-rw-r--r--chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala6
1 files changed, 3 insertions, 3 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala b/chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala
index 07546406..98253ce5 100644
--- a/chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala
+++ b/chiselFrontend/src/main/scala/chisel3/core/ChiselAnnotation.scala
@@ -45,9 +45,9 @@ case class ChiselAnnotation(component: InstanceId, transformClass: Class[_ <: Tr
* }
* }}}
*
- * @note Calling this on Data creates an annotation that Chisel emits to a separate annotations
- * file. This file must be passed to Firrtl independently of the .fir file.
- * [[chisel3.Driver.execute]] will do this automatically.
+ * @note Calling this on [[Data]] creates an annotation that Chisel emits to a separate annotations
+ * file. This file must be passed to FIRRTL independently of the `.fir` file. The execute methods
+ * in [[chisel3.Driver]] will pass the annotations to FIRRTL automatically.
*/
object dontTouch { // scalastyle:ignore object.name
/** Marks a signal to be preserved in Chisel and Firrtl