From 058f1624f274240c27592953c28b52a8c2af5d6a Mon Sep 17 00:00:00 2001 From: unlsycn Date: Tue, 19 Nov 2024 03:23:19 +0800 Subject: [PATCH] fix: fix wrong package name in HierarchyPackage (#4512) Signed-off-by: unlsycn --- .../hierarchy/HierarchyPackage.scala | 2 +- .../experimental/hierarchy/package.scala | 45 ------------------- 2 files changed, 1 insertion(+), 46 deletions(-) diff --git a/core/src/main/scala-2/chisel3/experimental/hierarchy/HierarchyPackage.scala b/core/src/main/scala-2/chisel3/experimental/hierarchy/HierarchyPackage.scala index 1b6db3629e1..d36b3de195b 100644 --- a/core/src/main/scala-2/chisel3/experimental/hierarchy/HierarchyPackage.scala +++ b/core/src/main/scala-2/chisel3/experimental/hierarchy/HierarchyPackage.scala @@ -1,4 +1,4 @@ -package chisel3.experimental +package chisel3.experimental.hierarchy /** Classes or traits which will be used with the [[Definition]] + [[Instance]] api should be marked * with the [[instantiable]] annotation at the class/trait definition. diff --git a/core/src/main/scala/chisel3/experimental/hierarchy/package.scala b/core/src/main/scala/chisel3/experimental/hierarchy/package.scala index e911b059798..c9f01706543 100644 --- a/core/src/main/scala/chisel3/experimental/hierarchy/package.scala +++ b/core/src/main/scala/chisel3/experimental/hierarchy/package.scala @@ -1,51 +1,6 @@ package chisel3.experimental package object hierarchy { - - /** Classes or traits which will be used with the [[Definition]] + [[Instance]] api should be marked - * with the [[instantiable]] annotation at the class/trait definition. - * - * @example {{{ - * @instantiable - * class MyModule extends Module { - * ... - * } - * - * val d = Definition(new MyModule) - * val i0 = Instance(d) - * val i1 = Instance(d) - * }}} - */ - class instantiable extends chisel3.internal.instantiable - - /** Classes marked with [[instantiable]] can have their vals marked with the [[public]] annotation to - * enable accessing these values from a [[Definition]] or [[Instance]] of the class. - * - * Only vals of the the following types can be marked [[public]]: - * 1. IsInstantiable - * 2. IsLookupable - * 3. Data - * 4. BaseModule - * 5. Iterable/Option containing a type that meets these requirements - * 6. Basic type like String, Int, BigInt etc. - * - * @example {{{ - * @instantiable - * class MyModule extends Module { - * @public val in = IO(Input(UInt(3.W))) - * @public val out = IO(Output(UInt(3.W))) - * .. - * } - * - * val d = Definition(new MyModule) - * val i0 = Instance(d) - * val i1 = Instance(d) - * - * i1.in := i0.out - * }}} - */ - class public extends chisel3.internal.public - type Instance[P] = core.Instance[P] val Instance = core.Instance type Definition[P] = core.Definition[P]