summaryrefslogtreecommitdiff
path: root/src/main/scala/chisel3/package.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/package.scala
parent2a4d4f0ee9fc924ee9ff8a12c7a04a4c8e9a106b (diff)
Provide package-level text to reduce ScalaDoc white space. (#432)
Diffstat (limited to 'src/main/scala/chisel3/package.scala')
-rw-r--r--src/main/scala/chisel3/package.scala3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/main/scala/chisel3/package.scala b/src/main/scala/chisel3/package.scala
index 109bd14e..c3531f3a 100644
--- a/src/main/scala/chisel3/package.scala
+++ b/src/main/scala/chisel3/package.scala
@@ -1,5 +1,8 @@
// See LICENSE for license details.
+/** The chisel3 package contains the chisel3 API.
+ * It maps core components into the public chisel3 namespace.
+ */
package object chisel3 { // scalastyle:ignore package.object.name
import scala.language.implicitConversions