diff options
| -rw-r--r-- | chiselFrontend/src/main/scala/chisel3/core/package.scala | 8 | ||||
| -rw-r--r-- | chiselFrontend/src/main/scala/chisel3/package.scala | 2 | ||||
| -rw-r--r-- | root-doc.txt | 2 |
3 files changed, 7 insertions, 5 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} diff --git a/root-doc.txt b/root-doc.txt index fa87d7b2..8dd60718 100644 --- a/root-doc.txt +++ b/root-doc.txt @@ -3,7 +3,7 @@ This is the documentation for Chisel. == Package structure == The [[chisel3]] package presents the public API of Chisel. -It contains the concrete core types [[chisel3.UInt `UInt`]], [[chisel3.SInt `SInt`]], [[chisel3.Bool `Bool`]], [[chisel3.FixedPoint `FixedPoint`]], [[chisel3.Clock `Clock`]], and [[chisel3.Reg `Reg`]], +It contains the concrete core types [[chisel3.UInt `UInt`]], [[chisel3.SInt `SInt`]], [[chisel3.Bool `Bool`]], [[chisel3.experimental.FixedPoint `FixedPoint`]], [[chisel3.Clock `Clock`]], and [[chisel3.Reg `Reg`]], the abstract types [[chisel3.Bits `Bits`]], [[chisel3.Aggregate `Aggregate`]], and [[chisel3.Data `Data`]], and the aggregate types [[chisel3.Bundle `Bundle`]] and [[chisel3.Vec `Vec`]]. |