summaryrefslogtreecommitdiff
path: root/chiselFrontend/src/main/scala/chisel3
diff options
context:
space:
mode:
authorJim Lawson2019-05-21 17:01:31 -0700
committerGitHub2019-05-21 17:01:31 -0700
commitdad4c2365c795c0963f538331d984efc09dcf49e (patch)
treef5ad0ad9e91e3c56d635f0353ed8752c51de7ed4 /chiselFrontend/src/main/scala/chisel3
parent387274784115bee2bf7167547a7ee459219e1413 (diff)
Minor Scaladoc update (#1099)
* Minor Scaladoc update - add/move package descriptive text - fix FixedPoint link (it's chisel3.experimental.FixedPoint) * Add missing period at EOS
Diffstat (limited to 'chiselFrontend/src/main/scala/chisel3')
-rw-r--r--chiselFrontend/src/main/scala/chisel3/core/package.scala8
-rw-r--r--chiselFrontend/src/main/scala/chisel3/package.scala2
2 files changed, 6 insertions, 4 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/package.scala b/chiselFrontend/src/main/scala/chisel3/core/package.scala
index ac69ca33..87e8c66d 100644
--- a/chiselFrontend/src/main/scala/chisel3/core/package.scala
+++ b/chiselFrontend/src/main/scala/chisel3/core/package.scala
@@ -2,12 +2,12 @@
package chisel3
+/**
+ * These definitions exist to deal with those clients that relied on chisel3.core.
+ * They are deprecated and will be removed in the future.
+ */
package object core {
- /**
- * These definitions exist to deal with those clients that relied on chisel3.core
- * They will be deprecated in the future.
- */
@deprecated("Use the version in chisel3._", "3.3")
val CompileOptions = chisel3.CompileOptions
diff --git a/chiselFrontend/src/main/scala/chisel3/package.scala b/chiselFrontend/src/main/scala/chisel3/package.scala
index d6c590b4..16d10ff7 100644
--- a/chiselFrontend/src/main/scala/chisel3/package.scala
+++ b/chiselFrontend/src/main/scala/chisel3/package.scala
@@ -1,5 +1,7 @@
// See LICENSE for license details.
+/** This package contains the main chisel3 API.
+ */
package object chisel3 { // scalastyle:ignore package.object.name
import internal.firrtl.{Port, Width}
import internal.sourceinfo.{SourceInfo, VecTransform}