diff options
| author | Schuyler Eldridge | 2018-08-14 11:43:37 -0400 |
|---|---|---|
| committer | Schuyler Eldridge | 2018-09-07 15:42:21 -0400 |
| commit | fefdc9441d248bf3d72e7e7e200a0caa63607049 (patch) | |
| tree | 08bc80e2a791b73d119e996726b63e2999767d66 /chiselFrontend | |
| parent | 57e8774c34fc28dd34cdec5e8a1bf82f3cd4e0cd (diff) | |
Put := and <> methods in Connect ScalaDoc group
This puts Data's connection methods, `:=` and `<>`, in the ScalaDoc
`Connect` group. These groups will propagate through to all children of
Data, e.g., UInt, and cause those methods to be grouped in the ScalaDoc of
these children.
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Diffstat (limited to 'chiselFrontend')
| -rw-r--r-- | chiselFrontend/src/main/scala/chisel3/core/Data.scala | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/chiselFrontend/src/main/scala/chisel3/core/Data.scala b/chiselFrontend/src/main/scala/chisel3/core/Data.scala index 04209cef..cab6075e 100644 --- a/chiselFrontend/src/main/scala/chisel3/core/Data.scala +++ b/chiselFrontend/src/main/scala/chisel3/core/Data.scala @@ -200,6 +200,7 @@ object Flipped { * from bits. * * @groupdesc Connect Utilities for connecting hardware components + * @define coll data */ abstract class Data extends HasId with NamedComponent with SourceInfoDoc { // This is a bad API that punches through object boundaries. @@ -384,7 +385,22 @@ abstract class Data extends HasId with NamedComponent with SourceInfoDoc { clone } + /** Connect this $coll to that $coll mono-directionally and element-wise. + * + * This uses the [[MonoConnect]] algorithm. + * + * @param that the $coll to connect to + * @group Connect + */ final def := (that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit = this.connect(that)(sourceInfo, connectionCompileOptions) + + /** Connect this $coll to that $coll bi-directionally and element-wise. + * + * This uses the [[BiConnect]] algorithm. + * + * @param that the $coll to connect to + * @group Connect + */ final def <> (that: Data)(implicit sourceInfo: SourceInfo, connectionCompileOptions: CompileOptions): Unit = this.bulkConnect(that)(sourceInfo, connectionCompileOptions) @chiselRuntimeDeprecated |
