summaryrefslogtreecommitdiff
path: root/chiselFrontend/src/main/scala/chisel3/core/Module.scala
diff options
context:
space:
mode:
authorSchuyler Eldridge2018-09-07 16:54:05 -0400
committerGitHub2018-09-07 16:54:05 -0400
commitc6144dc8354965722b3edc5c2a34892a78c5afee (patch)
treeb553e0cfb4f9133dcf90fecc61cfe4a4f7836380 /chiselFrontend/src/main/scala/chisel3/core/Module.scala
parent69d247becb5d66c566ba4face2852516dd28cde2 (diff)
parenta5de2b79a93e5acda2cf07bf37534e6782055960 (diff)
Merge pull request #873 from seldridge/issue-872
API Documentation Improvements
Diffstat (limited to 'chiselFrontend/src/main/scala/chisel3/core/Module.scala')
-rw-r--r--chiselFrontend/src/main/scala/chisel3/core/Module.scala4
1 files changed, 3 insertions, 1 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/Module.scala b/chiselFrontend/src/main/scala/chisel3/core/Module.scala
index 0cf05496..399f0462 100644
--- a/chiselFrontend/src/main/scala/chisel3/core/Module.scala
+++ b/chiselFrontend/src/main/scala/chisel3/core/Module.scala
@@ -12,10 +12,11 @@ import chisel3.internal._
import chisel3.internal.Builder._
import chisel3.internal.firrtl._
import chisel3.internal.sourceinfo.{InstTransform, SourceInfo}
+import chisel3.SourceInfoDoc
import _root_.firrtl.annotations.{CircuitName, ModuleName}
-object Module {
+object Module extends SourceInfoDoc {
/** A wrapper method that all Module instantiations must be wrapped in
* (necessary to help Chisel track internal state).
*
@@ -25,6 +26,7 @@ object Module {
*/
def apply[T <: BaseModule](bc: => T): T = macro InstTransform.apply[T]
+ /** @group SourceInfoTransformMacro */
def do_apply[T <: BaseModule](bc: => T)
(implicit sourceInfo: SourceInfo,
compileOptions: CompileOptions): T = {