diff options
| author | Chick Markley | 2020-03-26 11:43:24 -0700 |
|---|---|---|
| committer | GitHub | 2020-03-26 18:43:24 +0000 |
| commit | 249ed127cf6bf849f9895b8b603bececba1c5d76 (patch) | |
| tree | 5313d130d40184dedf7c8b8e1608df5db2c74acd /src/main/scala/firrtl/transforms/InferResets.scala | |
| parent | 5b58936df09163ed3f0690bd66e46b307c2a9654 (diff) | |
Eliminate warnings on `sbt doc` and `sbt unidoc` (#1470)
* Eliminate warnings on `sbt doc` and `sbt unidoc`
- removed toFirrtl reference on MultiTargetAnnotation
- lots of places where package path has to be added to comment references
- Change to use `/** text starts here` convention when wrong in comment with a doc fix.
- Did not exhaustively change these
- Wrestled doc example in RenderDiGraph#renderNode, not sure if I won
- Cleaned up InferWidths & CatchExceptions imports
- Added missing license message to a couple of files.
- fixed a couple of stale parameter names in scaladoc
- Added @unchecked to stop erasure warning in Emitting where emission annotations are collected
- Change types to [_] on match in RenameMap#recordAll to fix erasure warning
* Where possible change [[firrtl.ir.X]] to [[firrtl.ir.X X]] for better display in scaladoc
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Diffstat (limited to 'src/main/scala/firrtl/transforms/InferResets.scala')
| -rw-r--r-- | src/main/scala/firrtl/transforms/InferResets.scala | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/main/scala/firrtl/transforms/InferResets.scala b/src/main/scala/firrtl/transforms/InferResets.scala index 72724b27..4342f276 100644 --- a/src/main/scala/firrtl/transforms/InferResets.scala +++ b/src/main/scala/firrtl/transforms/InferResets.scala @@ -96,7 +96,7 @@ object InferResets { } } -/** Infers the concrete type of [[ResetType]]s by their connections +/** Infers the concrete type of [[firrtl.ir.ResetType ResetType]]s by their connections * * There are 3 cases * 1. An abstract reset driven by and/or driving only asynchronous resets will be inferred as @@ -105,7 +105,7 @@ object InferResets { * error * 1. Otherwise, the reset is inferred as synchronous (i.e. the abstract reset is only invalidated * or is driven by or drives only synchronous resets) - * @note This is a global inference because ports can be of type [[ResetType]] + * @note This is a global inference because ports can be of type [[firrtl.ir.ResetType ResetType]] * @note This transform should be run before [[DedupModules]] so that similar Modules from * generator languages like Chisel can infer differently */ |