diff options
author | pboutill <pboutill@85f007b7-540e-0410-9357-904b9bb8a0f7> | 2010-04-29 09:56:37 +0000 |
---|---|---|
committer | pboutill <pboutill@85f007b7-540e-0410-9357-904b9bb8a0f7> | 2010-04-29 09:56:37 +0000 |
commit | f73d7c4614d000f068550b5144d80b7eceed58e9 (patch) | |
tree | 4fa9a679a6e55269cc5c7cf24fce725acb2574b5 /kernel/typeops.mli | |
parent | 552e596e81362e348fc17fcebcc428005934bed6 (diff) |
Move from ocamlweb to ocamdoc to generate mli documentation
dev/ocamlweb-doc has been erased. I hope no one still use the
"new-parse" it generate.
In dev/,
make html will generate in dev/html/ "clickable version of mlis". (as
the caml standard library)
make coq.pdf will generate nearly the same awfull stuff that coq.ps was.
make {kernel,lib,parsing,..}.{dot,png} will do the dependancy graph of
the given directory.
ocamldoc comment syntax is here :
http://caml.inria.fr/pub/docs/manual-ocaml/manual029.html
The possibility to put graphs in pdf/html seems to be lost.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/coq/trunk@12969 85f007b7-540e-0410-9357-904b9bb8a0f7
Diffstat (limited to 'kernel/typeops.mli')
-rw-r--r-- | kernel/typeops.mli | 52 |
1 files changed, 25 insertions, 27 deletions
diff --git a/kernel/typeops.mli b/kernel/typeops.mli index b0f15e75d..a89aae4d2 100644 --- a/kernel/typeops.mli +++ b/kernel/typeops.mli @@ -1,23 +1,21 @@ -(************************************************************************) -(* v * The Coq Proof Assistant / The Coq Development Team *) -(* <O___,, * CNRS-Ecole Polytechnique-INRIA Futurs-Universite Paris Sud *) -(* \VV/ **************************************************************) -(* // * This file is distributed under the terms of the *) -(* * GNU Lesser General Public License Version 2.1 *) -(************************************************************************) +(*********************************************************************** + v * The Coq Proof Assistant / The Coq Development Team + <O___,, * CNRS-Ecole Polytechnique-INRIA Futurs-Universite Paris Sud + \VV/ ************************************************************* + // * This file is distributed under the terms of the + * GNU Lesser General Public License Version 2.1 + ***********************************************************************) (*i $Id$ i*) -(*i*) open Names open Univ open Term open Environ open Entries open Declarations -(*i*) -(*s Typing functions (not yet tagged as safe) *) +(** {6 Typing functions (not yet tagged as safe) } *) val infer : env -> constr -> unsafe_judgment * constraints val infer_v : env -> constr array -> unsafe_judgment array * constraints @@ -27,56 +25,56 @@ val infer_local_decls : env -> (identifier * local_entry) list -> env * rel_context * constraints -(*s Basic operations of the typing machine. *) +(** {6 Basic operations of the typing machine. } *) -(* If [j] is the judgement $c:t$, then [assumption_of_judgement env j] - returns the type $c$, checking that $t$ is a sort. *) +(** If [j] is the judgement {% $ %}c:t{% $ %}, then [assumption_of_judgement env j] + returns the type {% $ %}c{% $ %}, checking that {% $ %}t{% $ %} is a sort. *) val assumption_of_judgment : env -> unsafe_judgment -> types val type_judgment : env -> unsafe_judgment -> unsafe_type_judgment -(*s Type of sorts. *) +(** {6 Type of sorts. } *) val judge_of_prop_contents : contents -> unsafe_judgment val judge_of_type : universe -> unsafe_judgment -(*s Type of a bound variable. *) +(** {6 Type of a bound variable. } *) val judge_of_relative : env -> int -> unsafe_judgment -(*s Type of variables *) +(** {6 Type of variables } *) val judge_of_variable : env -> variable -> unsafe_judgment -(*s type of a constant *) +(** {6 type of a constant } *) val judge_of_constant : env -> constant -> unsafe_judgment val judge_of_constant_knowing_parameters : env -> constant -> unsafe_judgment array -> unsafe_judgment -(*s Type of application. *) +(** {6 Type of application. } *) val judge_of_apply : env -> unsafe_judgment -> unsafe_judgment array -> unsafe_judgment * constraints -(*s Type of an abstraction. *) +(** {6 Type of an abstraction. } *) val judge_of_abstraction : env -> name -> unsafe_type_judgment -> unsafe_judgment -> unsafe_judgment -(*s Type of a product. *) +(** {6 Type of a product. } *) val judge_of_product : env -> name -> unsafe_type_judgment -> unsafe_type_judgment -> unsafe_judgment -(* s Type of a let in. *) +(** s Type of a let in. *) val judge_of_letin : env -> name -> unsafe_judgment -> unsafe_type_judgment -> unsafe_judgment -> unsafe_judgment -(*s Type of a cast. *) +(** {6 Type of a cast. } *) val judge_of_cast : env -> unsafe_judgment -> cast_kind -> unsafe_type_judgment -> unsafe_judgment * constraints -(*s Inductive types. *) +(** {6 Inductive types. } *) val judge_of_inductive : env -> inductive -> unsafe_judgment @@ -85,16 +83,16 @@ val judge_of_inductive_knowing_parameters : val judge_of_constructor : env -> constructor -> unsafe_judgment -(*s Type of Cases. *) +(** {6 Type of Cases. } *) val judge_of_case : env -> case_info -> unsafe_judgment -> unsafe_judgment -> unsafe_judgment array -> unsafe_judgment * constraints -(* Typecheck general fixpoint (not checking guard conditions) *) +(** Typecheck general fixpoint (not checking guard conditions) *) val type_fixpoint : env -> name array -> types array -> unsafe_judgment array -> constraints -(* Kernel safe typing but applicable to partial proofs *) +(** Kernel safe typing but applicable to partial proofs *) val typing : env -> constr -> unsafe_judgment val type_of_constant : env -> constant -> types @@ -104,7 +102,7 @@ val type_of_constant_type : env -> constant_type -> types val type_of_constant_knowing_parameters : env -> constant_type -> constr array -> types -(* Make a type polymorphic if an arity *) +(** Make a type polymorphic if an arity *) val make_polymorphic_if_constant_for_ind : env -> unsafe_judgment -> constant_type |