From a5de2b79a93e5acda2cf07bf37534e6782055960 Mon Sep 17 00:00:00 2001 From: Schuyler Eldridge Date: Tue, 14 Aug 2018 22:58:48 -0400 Subject: Add ToBoolable ScalaDoc documentation Signed-off-by: Schuyler Eldridge --- chiselFrontend/src/main/scala/chisel3/core/Bits.scala | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'chiselFrontend/src/main/scala') diff --git a/chiselFrontend/src/main/scala/chisel3/core/Bits.scala b/chiselFrontend/src/main/scala/chisel3/core/Bits.scala index a889a89b..e9458446 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Bits.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Bits.scala @@ -45,14 +45,15 @@ abstract class Element(private[chisel3] val width: Width) extends Data { } } -/** Exists to unify common interfaces of [[Bits]] and [[Reset]] - * Workaround because macros cannot override abstract methods +/** Exists to unify common interfaces of [[Bits]] and [[Reset]]. + * + * @note This is a workaround because macros cannot override abstract methods. */ private[chisel3] sealed trait ToBoolable extends Element { - /** Casts this object to a [[Bool]] + /** Casts this $coll to a [[Bool]] * - * @note Width must be known and equal to 1 + * @note The width must be known and equal to 1 */ final def toBool(): Bool = macro SourceInfoWhiteboxTransform.noArg -- cgit v1.2.3