summaryrefslogtreecommitdiff
path: root/src/rewriter.mli
diff options
context:
space:
mode:
authorAlasdair Armstrong2019-03-11 13:03:07 +0000
committerAlasdair Armstrong2019-03-11 14:42:09 +0000
commit711de1e76e82026e361f232010304175f0542c3d (patch)
tree7a3286b5075629fdc8beec44cfbd7d2ab1329d4e /src/rewriter.mli
parent9c4c0e8770a43bb097df243050163afd1b31cc8f (diff)
Improve ocamldoc comments
Check in a slightly nicer stylesheet for OCamldoc generated documentation in etc. Most just add a maximum width and increase the font size because the default looks absolutely terrible on high-DPI monitors. Move val_spec_ids out of initial_check and into ast_util where it probably belongs. Rename some functions in util.ml to better match the OCaml stdlib.
Diffstat (limited to 'src/rewriter.mli')
-rw-r--r--src/rewriter.mli8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/rewriter.mli b/src/rewriter.mli
index ec4e381c..ab29d1d9 100644
--- a/src/rewriter.mli
+++ b/src/rewriter.mli
@@ -48,6 +48,8 @@
(* SUCH DAMAGE. *)
(**************************************************************************)
+(** General rewriting framework for Sail->Sail rewrites *)
+
module Big_int = Nat_big_num
open Ast
open Type_check
@@ -65,14 +67,14 @@ val rewrite_exp : tannot rewriters -> tannot exp -> tannot exp
val rewriters_base : tannot rewriters
-(* The identity re-writer *)
+(** The identity re-writer *)
val rewrite_defs : tannot defs -> tannot defs
val rewrite_defs_base : tannot rewriters -> tannot defs -> tannot defs
val rewrite_defs_base_parallel : int -> tannot rewriters -> tannot defs -> tannot defs
-
-(* Same as rewrite_defs base but display a progress bar when verbosity >= 1 *)
+
+(** Same as rewrite_defs_base but display a progress bar when verbosity >= 1 *)
val rewrite_defs_base_progress : string -> tannot rewriters -> tannot defs -> tannot defs
val rewrite_lexp : tannot rewriters -> tannot lexp -> tannot lexp