summaryrefslogtreecommitdiff
path: root/src/jib/jib_compile.mli
diff options
context:
space:
mode:
Diffstat (limited to 'src/jib/jib_compile.mli')
-rw-r--r--src/jib/jib_compile.mli7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/jib/jib_compile.mli b/src/jib/jib_compile.mli
index 92a0d06a..173e5c5f 100644
--- a/src/jib/jib_compile.mli
+++ b/src/jib/jib_compile.mli
@@ -48,6 +48,8 @@
(* SUCH DAMAGE. *)
(**************************************************************************)
+(** Compile Sail ASTs to Jib intermediate representation *)
+
open Anf
open Ast
open Ast_util
@@ -57,6 +59,9 @@ open Type_check
(** Print the IR representation of a specific function. *)
val opt_debug_function : string ref
+
+(** {2 Jib context} *)
+
(** Context for compiling Sail to Jib. We need to pass a (global)
typechecking environment given by checking the full AST. We have to
provide a conversion function from Sail types into Jib types, as
@@ -81,6 +86,8 @@ val initial_ctx :
Env.t ->
ctx
+(** {2 Compilation functions} *)
+
(** Compile a Sail definition into a Jib definition. The first two
arguments are is the current definition number and the total number
of definitions, and can be used to drive a progress bar (see