From dffa5374ca560213452039fe569a70ca21b58a85 Mon Sep 17 00:00:00 2001
From: Tuowen Zhao <ztuowen@gmail.com>
Date: Sat, 17 Sep 2016 19:21:10 -0600
Subject: added file doc

---
 chill/include/ir_code.hh | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'chill/include/ir_code.hh')

diff --git a/chill/include/ir_code.hh b/chill/include/ir_code.hh
index b6ebfcd..d695474 100644
--- a/chill/include/ir_code.hh
+++ b/chill/include/ir_code.hh
@@ -22,6 +22,18 @@
 #ifndef IR_CODE_HH
 #define IR_CODE_HH
 
+/*!
+ * \file
+ * \brief CHiLL's compiler intermediate representation interface that extends Omega's builder interface to accomodate compiler analyses and extra code generation.
+ * 
+ * Unlike CG_outputRepr, IR_Symbol,IR_Ref and IR_Control are place holders 
+ * to the underlying code, thus deleting or duplicating them does not affect
+ * the actual code.  Similar to Omega builder's memory allocation strategy,
+ * all non-const pointer parameters of CG_outputRepr/IR_Symbol/IR_Ref/IR_Control
+ * are destroyed after the call.
+ */
+
+
 #include <code_gen/CG_outputRepr.h>
 #include <code_gen/CG_outputBuilder.h>
 #include <vector>
-- 
cgit v1.2.3-70-g09d2