From 5c3b19d6fb90d7c3d8f49d120a49d477c6bd5ec9 Mon Sep 17 00:00:00 2001 From: Schuyler Eldridge Date: Tue, 14 Aug 2018 22:57:47 -0400 Subject: Add Element ScalaDoc documentation Minor updates to Element's documentation to conform with ScalaDoc style. Signed-off-by: Schuyler Eldridge --- chiselFrontend/src/main/scala/chisel3/core/Bits.scala | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'chiselFrontend/src') 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) { -- cgit v1.2.3