Address reviewer comments on #416

1 files changed, 17 insertions, 2 deletions

diff --git a/src/dotty/tools/dotc/CompilationUnit.scala b/src/dotty/tools/dotc/CompilationUnit.scala
index 2f5f1202d..de51a84cf 100644
--- a/src/dotty/tools/dotc/CompilationUnit.scala
+++ b/src/dotty/tools/dotc/CompilationUnit.scala
@@ -17,10 +17,25 @@ class CompilationUnit(val source: SourceFile) {
   var tpdTree: tpd.Tree = tpd.EmptyTree
 
   def isJava = source.file.name.endsWith(".java")
-  
-  lazy val pickled: TastyPickler = new TastyPickler()
 
+  /**
+   * Pickler used to create TASTY sections.
+   * Sections: Header, ASTs and Positions are populated by `pickler` phase.
+   * Subsequent phases can add new sections.
+   */
+  lazy val pickler: TastyPickler = new TastyPickler()
+
+  /**
+   * Addresses in TASTY file of trees, stored by pickling.
+   * Note that trees are checked for reference equality,
+   * so one can reliably use this function only dirrectly after `pickler`
+   */
   var addrOfTree: tpd.Tree => Option[Addr] = (_ => None)
 
+  /**
+   * Addresses in TASTY file of symbols, stored by pickling.
+   * Note that trees are checked for reference equality,
+   * so one can reliably use this function only dirrectly after `pickler`
+   */
   var addrOfSym: Symbol => Option[Addr] = (_ => None)
 }
\ No newline at end of file