From 2edad4e3903ee77155f8b164c6cf6df49c897a27 Mon Sep 17 00:00:00 2001 From: Pierre-Marie Pédrot Date: Thu, 6 Aug 2020 12:37:22 +0200 Subject: Add a few comments about the code. --- engine/evarutil.mli | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'engine') diff --git a/engine/evarutil.mli b/engine/evarutil.mli index 8083bb86c3..a8fc9ef5e2 100644 --- a/engine/evarutil.mli +++ b/engine/evarutil.mli @@ -40,6 +40,15 @@ val new_evar : ?principal:bool -> ?hypnaming:naming_mode -> env -> evar_map -> types -> evar_map * EConstr.t +(** Low-level interface to create an evar. + @param src User-facing source for the evar + @param filter See {!Evd.Filter}, must be the same length as [named_context_val] + @param identity See {!Evd.Identity}, must be the name projection of [named_context_val] + @param naming A naming scheme for the evar + @param principal Whether the evar is the principal goal + @param named_context_val The context of the evar + @param types The type of conclusion of the evar +*) val new_pure_evar : ?src:Evar_kinds.t Loc.located -> ?filter:Filter.t -> ?identity:EConstr.t list -> -- cgit v1.2.3