Merge pull request #1022 from freechipsproject/cleanup-scaladoc

Miscellaneous Scaladoc Cleanup

1 files changed, 11 insertions, 15 deletions

diff --git a/coreMacros/src/main/scala/chisel3/SourceInfoDoc.scala b/coreMacros/src/main/scala/chisel3/SourceInfoDoc.scala
index 4e7533d4..4b6b0a8c 100644
--- a/coreMacros/src/main/scala/chisel3/SourceInfoDoc.scala
+++ b/coreMacros/src/main/scala/chisel3/SourceInfoDoc.scala
@@ -15,27 +15,23 @@ package chisel3
   *   <br>
   *
   *   The equivalent public-facing methods do not have the `do_` prefix or have the same name. Use and look at the
-  *   documentation for those. If you want left shift, use `<<`, not `do_<<`. If you want comversion to a [[Seq]] of
-  *   [[Bool]]s look at the `asBools` above, not the one below. Users can safely ignore every method in this group!
-  *   <br>
-  *   <br>
+  *   documentation for those. If you want left shift, use `<<`, not `do_<<`. If you want conversion to a
+  *   [[scala.collection.Seq Seq]] of [[Bool]]s look at the `asBools` above, not the one below. Users can safely ignore
+  *   every method in this group! <br> <br>
   *
   *   🐉🐉🐉 '''Here be dragons...''' 🐉🐉🐉
   *   <br>
   *   <br>
   *
-  *   These `do_X` methods are used to enable both implicit passing of [[SourceInfo]] and
-  *   [[chisel3.core.CompileOptions]] while also supporting chained apply methods. In effect all "normal" methods that
-  *   you, as a user, will use in your designs, are converted to their "hidden", `do_*`, via macro transformations.
-  *   Without using macros here, only one of the above wanted behaviors is allowed (implicit passing and chained
-  *   applies)---the compiler interprets a chained apply as an explicit 'implicit' argument and will throw type errors.
-  *   <br>
-  *   <br>
+  *   These `do_X` methods are used to enable both implicit passing of SourceInfo and [[chisel3.core.CompileOptions]]
+  *   while also supporting chained apply methods. In effect all "normal" methods that you, as a user, will use in your
+  *   designs, are converted to their "hidden", `do_*`, via macro transformations. Without using macros here, only one
+  *   of the above wanted behaviors is allowed (implicit passing and chained applies)---the compiler interprets a
+  *   chained apply as an explicit 'implicit' argument and will throw type errors. <br> <br>
   *
-  *   The "normal", public-facing methods then take no [[SourceInfo]]. However, a macro transforms this public-facing
-  *   method into a call to an internal, hidden `do_*` that takes an explicit [[SourceInfo]] by inserting an
-  *   `implicitly[SourceInfo]` as the explicit argument.
-  * </p>
+  *   The "normal", public-facing methods then take no SourceInfo. However, a macro transforms this public-facing method
+  *   into a call to an internal, hidden `do_*` that takes an explicit SourceInfo by inserting an
+  *   `implicitly[SourceInfo]` as the explicit argument. </p>
   *
   * @groupprio SourceInfoTransformMacro 1001
   */