From a5aba40349e290c30280df25bc5b0ba848183469 Mon Sep 17 00:00:00 2001
From: Jim Lawson
Date: Thu, 6 Oct 2016 10:40:10 -0700
Subject: Add comments; correct Complex definition (use cloneType).

---
 chiselFrontend/src/main/scala/chisel3/core/Data.scala | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'chiselFrontend')

diff --git a/chiselFrontend/src/main/scala/chisel3/core/Data.scala b/chiselFrontend/src/main/scala/chisel3/core/Data.scala
index 867c5a16..e95b4352 100644
--- a/chiselFrontend/src/main/scala/chisel3/core/Data.scala
+++ b/chiselFrontend/src/main/scala/chisel3/core/Data.scala
@@ -155,7 +155,19 @@ abstract class Data extends HasId {
   private[chisel3] def toType: String
   private[core] def width: Width
 
+  /** cloneType must be defined for any Chisel object extending Data.
+    * It is responsible for constructing a basic copy of the object being cloned.
+    * If cloneType needs to recursively clone elements of an object, it should call
+    * the cloneType methods on those elements.
+    * @return a copy of the object.
+    */
   def cloneType: this.type
+
+  /** chiselCloneType is called at the top-level of a clone chain.
+    * It calls the client's cloneType() method to construct a basic copy of the object being cloned,
+    * then performs any fixups required to reconstruct the appropriate core state of the cloned object.
+    * @return a copy of the object with appropriate core state.
+    */
   def chiselCloneType: this.type = {
     // Call the user-supplied cloneType method
     val clone = this.cloneType
-- 
cgit v1.2.3