add documentation for DecodeTableAnnotation.

1 files changed, 9 insertions, 0 deletions

diff --git a/src/main/scala/chisel3/util/experimental/decode/DecodeTableAnnotation.scala b/src/main/scala/chisel3/util/experimental/decode/DecodeTableAnnotation.scala
index cd289a5d..2b50ef90 100644
--- a/src/main/scala/chisel3/util/experimental/decode/DecodeTableAnnotation.scala
+++ b/src/main/scala/chisel3/util/experimental/decode/DecodeTableAnnotation.scala
@@ -4,6 +4,15 @@ package chisel3.util.experimental.decode
 
 import firrtl.annotations.{Annotation, ReferenceTarget, SingleTargetAnnotation}
 
+/** DecodeTableAnnotation used to store a decode result for a specific [[TruthTable]].
+  * This is useful for saving large [[TruthTable]] during a elaboration time.
+  *
+  * @note user should manage the correctness of [[minimizedTable]].
+  *
+  * @param target output wire of a decoder.
+  * @param truthTable input [[TruthTable]] encoded in a serialized [[TruthTable]].
+  * @param minimizedTable minimized [[truthTable]] encoded in a serialized [[TruthTable]].
+  */
 case class DecodeTableAnnotation(
   target:         ReferenceTarget,
   truthTable:     String,