diff options
Diffstat (limited to 'src/main/scala/firrtl/annotations')
| -rw-r--r-- | src/main/scala/firrtl/annotations/Annotation.scala | 3 | ||||
| -rw-r--r-- | src/main/scala/firrtl/annotations/LoadMemoryAnnotation.scala | 8 |
2 files changed, 4 insertions, 7 deletions
diff --git a/src/main/scala/firrtl/annotations/Annotation.scala b/src/main/scala/firrtl/annotations/Annotation.scala index 62c2b335..25e361f3 100644 --- a/src/main/scala/firrtl/annotations/Annotation.scala +++ b/src/main/scala/firrtl/annotations/Annotation.scala @@ -34,7 +34,7 @@ trait Annotation extends Product { }.foldRight(Seq.empty[Target])((seq, c) => c ++ seq) } - /** Returns all [[Target]] members in this annotation + /** Returns all [[firrtl.annotations.Target Target]] members in this annotation * @return */ def getTargets: Seq[Target] = extractComponents(productIterator.toSeq) @@ -210,4 +210,3 @@ private[firrtl] object LegacyAnnotation { case class DeletedAnnotation(xFormName: String, anno: Annotation) extends NoTargetAnnotation { override def serialize: String = s"""DELETED by $xFormName\n${anno.serialize}""" } - diff --git a/src/main/scala/firrtl/annotations/LoadMemoryAnnotation.scala b/src/main/scala/firrtl/annotations/LoadMemoryAnnotation.scala index 7c7ef096..c5dae954 100644 --- a/src/main/scala/firrtl/annotations/LoadMemoryAnnotation.scala +++ b/src/main/scala/firrtl/annotations/LoadMemoryAnnotation.scala @@ -4,8 +4,7 @@ package firrtl.annotations import java.io.File -/** - * Enumeration of the two types of readmem statements available in verilog +/** Enumeration of the two types of `readmem` statements available in Verilog. */ object MemoryLoadFileType extends Enumeration { type FileType = Value @@ -14,11 +13,10 @@ object MemoryLoadFileType extends Enumeration { val Binary: Value = Value("b") } -/** - * Firrtl implementation for load memory +/** Firrtl implementation for load memory * @param target memory to load * @param fileName name of input file - * @param hexOrBinary use $readmemh or $readmemb + * @param hexOrBinary use `\$readmemh` or `\$readmemb` */ case class LoadMemoryAnnotation( target: ComponentName, |