diff options
| author | Schuyler Eldridge | 2018-08-14 22:57:47 -0400 |
|---|---|---|
| committer | Schuyler Eldridge | 2018-09-07 15:42:21 -0400 |
| commit | 5c3b19d6fb90d7c3d8f49d120a49d477c6bd5ec9 (patch) | |
| tree | 3b39d89d46d160c3d5a6a43ca6c030f619bff5f5 /chiselFrontend/src/main/scala/chisel3/core | |
| parent | c600d0b1e68f994c48e1abb961c734c7ba36f720 (diff) | |
Add Element ScalaDoc documentation
Minor updates to Element's documentation to conform with ScalaDoc style.
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Diffstat (limited to 'chiselFrontend/src/main/scala/chisel3/core')
| -rw-r--r-- | chiselFrontend/src/main/scala/chisel3/core/Bits.scala | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/Bits.scala b/chiselFrontend/src/main/scala/chisel3/core/Bits.scala index 3e0ddc0a..a889a89b 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Bits.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Bits.scala @@ -14,8 +14,10 @@ import chisel3.internal.firrtl.PrimOp._ //scalastyle:off method.name -/** Element is a leaf data type: it cannot contain other Data objects. Example - * uses are for representing primitive data types, like integers and bits. +/** Element is a leaf data type: it cannot contain other [[Data]] objects. Example uses are for representing primitive + * data types, like integers and bits. + * + * @define coll element */ abstract class Element(private[chisel3] val width: Width) extends Data { private[chisel3] override def bind(target: Binding, parentDirection: SpecifiedDirection) { |