Improve some of the ScalaDoc in chisel3.util

1 files changed, 9 insertions, 7 deletions

diff --git a/src/main/scala/chisel3/util/Valid.scala b/src/main/scala/chisel3/util/Valid.scala
index 7017b7a1..95f0dcea 100644
--- a/src/main/scala/chisel3/util/Valid.scala
+++ b/src/main/scala/chisel3/util/Valid.scala
@@ -24,13 +24,15 @@ object Valid {
 }
 
 /** A hardware module that delays data coming down the pipeline
-  by the number of cycles set by the latency parameter. Functionality
-  is similar to ShiftRegister but this exposes a Pipe interface.
-
-  Example usage:
-    val pipe = new Pipe(UInt())
-    pipe.io.enq <> produce.io.out
-    consumer.io.in <> pipe.io.deq
+  * by the number of cycles set by the latency parameter. Functionality
+  * is similar to ShiftRegister but this exposes a Pipe interface.
+  *
+  * Example usage:
+  * {{{
+  *   val pipe = new Pipe(UInt())
+  *   pipe.io.enq <> produce.io.out
+  *   consumer.io.in <> pipe.io.deq
+  * }}}
   */
 object Pipe
 {