Merge pull request #1022 from freechipsproject/cleanup-scaladoc

Miscellaneous Scaladoc Cleanup

1 files changed, 8 insertions, 11 deletions

diff --git a/chiselFrontend/src/main/scala/chisel3/core/Reg.scala b/chiselFrontend/src/main/scala/chisel3/core/Reg.scala
index 27156f8b..747fad73 100644
--- a/chiselFrontend/src/main/scala/chisel3/core/Reg.scala
+++ b/chiselFrontend/src/main/scala/chisel3/core/Reg.scala
@@ -30,10 +30,9 @@ import chisel3.internal.sourceinfo.{SourceInfo}
   *
   */
 object Reg {
-  /** @usecase def apply[T <: Data](t: T): T
-    *   Construct a [[Reg]] from a type template with no initialization value (reset is ignored).
-    *   Value will not change unless the [[Reg]] is given a connection.
-    *   @param t The template from which to construct this wire
+  /** Construct a [[Reg]] from a type template with no initialization value (reset is ignored).
+    * Value will not change unless the [[Reg]] is given a connection.
+    * @param t The template from which to construct this wire
     */
   def apply[T <: Data](t: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = {
     if (compileOptions.declaredTypeMustBeUnbound) {
@@ -143,10 +142,9 @@ object RegNext {
   * }}}
   */
 object RegInit {
-  /** @usecase def apply[T <: Data](t: T, init: T): T
-    *   Construct a [[Reg]] from a type template initialized to the specified value on reset
-    *   @param t The type template used to construct this [[Reg]]
-    *   @param init The value the [[Reg]] is initialized to on reset
+  /** Construct a [[Reg]] from a type template initialized to the specified value on reset
+    * @param t The type template used to construct this [[Reg]]
+    * @param init The value the [[Reg]] is initialized to on reset
     */
   def apply[T <: Data](t: T, init: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = {
     if (compileOptions.declaredTypeMustBeUnbound) {
@@ -162,9 +160,8 @@ object RegInit {
     reg
   }
 
-  /** @usecase def apply[T <: Data](init: T): T
-    *   Construct a [[Reg]] initialized on reset to the specified value.
-    *   @param init Initial value that serves as a type template and reset value
+  /** Construct a [[Reg]] initialized on reset to the specified value.
+    * @param init Initial value that serves as a type template and reset value
     */
   def apply[T <: Data](init: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T = {
     val model = (init match {