summaryrefslogtreecommitdiff
path: root/chiselFrontend
diff options
context:
space:
mode:
authorSchuyler Eldridge2018-08-14 22:58:48 -0400
committerSchuyler Eldridge2018-09-07 15:42:21 -0400
commita5de2b79a93e5acda2cf07bf37534e6782055960 (patch)
treeb553e0cfb4f9133dcf90fecc61cfe4a4f7836380 /chiselFrontend
parent5c3b19d6fb90d7c3d8f49d120a49d477c6bd5ec9 (diff)
Add ToBoolable ScalaDoc documentation
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Diffstat (limited to 'chiselFrontend')
-rw-r--r--chiselFrontend/src/main/scala/chisel3/core/Bits.scala9
1 files changed, 5 insertions, 4 deletions
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