Document eurm transformation functions

1 files changed, 11 insertions, 0 deletions

diff --git a/eurml.mli b/eurml.mli
index 1b13dca..8fd8ef1 100644
--- a/eurml.mli
+++ b/eurml.mli
@@ -5,10 +5,21 @@
 
 open Common
 
+(* Strips out comments and rewrite/enumerate labels *)
 val compile_preprocess : eurmcmd list -> eurmcmd list
+
+(* Rewrites Dec, GEqPredicate, LEqPredicate, LTPredicate, Mult and ZeroPredicate *)
 val compile_stage1 : eurmcmd list -> state -> eurmcmd list * state
+
+(* Rewrites Add, GTPredicate and Sub *)
 val compile_stage2 : eurmcmd list -> state -> eurmcmd list * state
+
+(* Rewrites Goto *)
 val compile_stage3 : eurmcmd list -> state -> eurmcmd list * state
+
+(* Rewrites Inc, EqPredicate, Label and Zero *)
 val compile_stage4 : eurmcmd list -> state -> urmcmd list * state
+
+(* Transcompiles an EURM instruction sequence into URM *)
 val urm_from_eurm : eurmcmd list -> urmcmd list