summaryrefslogtreecommitdiff
path: root/src/main/scala/chisel3/compatibility.scala
diff options
context:
space:
mode:
authorJim Lawson2017-01-27 10:58:38 -0800
committerJack Koenig2017-01-27 10:58:38 -0800
commit295315a5ec83dc3173d6ae2437c11e1d8414f774 (patch)
tree6c7d4a0fed59da1c4282e525b4c82a74146d0c16 /src/main/scala/chisel3/compatibility.scala
parent2a4d4f0ee9fc924ee9ff8a12c7a04a4c8e9a106b (diff)
Provide package-level text to reduce ScalaDoc white space. (#432)
Diffstat (limited to 'src/main/scala/chisel3/compatibility.scala')
-rw-r--r--src/main/scala/chisel3/compatibility.scala5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/main/scala/chisel3/compatibility.scala b/src/main/scala/chisel3/compatibility.scala
index a919e3b9..d7ce7f24 100644
--- a/src/main/scala/chisel3/compatibility.scala
+++ b/src/main/scala/chisel3/compatibility.scala
@@ -1,7 +1,8 @@
// See LICENSE for license details.
-// Allows legacy users to continue using Chisel (capital C) package name while
-// moving to the more standard package naming convention chisel3 (lowercase c).
+/** The Chisel compatibility package allows legacy users to continue using the `Chisel` (capital C) package name
+ * while moving to the more standard package naming convention `chisel3` (lowercase c).
+ */
package object Chisel { // scalastyle:ignore package.object.name
import chisel3.internal.firrtl.Width