diff options
| author | pboutill | 2010-04-29 09:56:37 +0000 |
|---|---|---|
| committer | pboutill | 2010-04-29 09:56:37 +0000 |
| commit | f73d7c4614d000f068550b5144d80b7eceed58e9 (patch) | |
| tree | 4fa9a679a6e55269cc5c7cf24fce725acb2574b5 /parsing/printer.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 'parsing/printer.mli')
| -rw-r--r-- | parsing/printer.mli | 38 |
1 files changed, 18 insertions, 20 deletions
diff --git a/parsing/printer.mli b/parsing/printer.mli index 2c1586abf7..6289fa66a7 100644 --- a/parsing/printer.mli +++ b/parsing/printer.mli @@ -1,14 +1,13 @@ -(************************************************************************) -(* 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 Pp open Names open Libnames @@ -23,11 +22,10 @@ open Evd open Proof_type open Rawterm open Tacexpr -(*i*) -(* These are the entry points for printing terms, context, tac, ... *) +(** These are the entry points for printing terms, context, tac, ... *) -(* Terms *) +(** Terms *) val pr_lconstr_env : env -> constr -> std_ppcmds val pr_lconstr_env_at_top : env -> constr -> std_ppcmds @@ -68,7 +66,7 @@ val pr_cases_pattern : cases_pattern -> std_ppcmds val pr_sort : sorts -> std_ppcmds -(* Printing global references using names as short as possible *) +(** Printing global references using names as short as possible *) val pr_global_env : Idset.t -> global_reference -> std_ppcmds val pr_global : global_reference -> std_ppcmds @@ -79,7 +77,7 @@ val pr_constructor : env -> constructor -> std_ppcmds val pr_inductive : env -> inductive -> std_ppcmds val pr_evaluable_reference : evaluable_global_reference -> std_ppcmds -(* Contexts *) +(** Contexts *) val pr_ne_context_of : std_ppcmds -> env -> std_ppcmds @@ -92,14 +90,14 @@ val pr_rel_context : env -> rel_context -> std_ppcmds val pr_rel_context_of : env -> std_ppcmds val pr_context_of : env -> std_ppcmds -(* Predicates *) +(** Predicates *) val pr_predicate : ('a -> std_ppcmds) -> (bool * 'a list) -> std_ppcmds val pr_cpred : Cpred.t -> std_ppcmds val pr_idpred : Idpred.t -> std_ppcmds val pr_transparent_state : transparent_state -> std_ppcmds -(* Proofs *) +(** Proofs *) val pr_goal : goal sigma -> std_ppcmds val pr_subgoals : string option -> evar_map -> goal list -> std_ppcmds @@ -111,19 +109,19 @@ val pr_evars_int : int -> (evar * evar_info) list -> std_ppcmds val pr_prim_rule : prim_rule -> std_ppcmds -(* Emacs/proof general support *) -(* (emacs_str s alts) outputs +(** Emacs/proof general support + (emacs_str s alts) outputs - s if emacs mode & unicode allowed, - alts if emacs mode and & unicode not allowed - nothing otherwise *) val emacs_str : string -> string -> string -(* Backwards compatibility *) +(** Backwards compatibility *) -val prterm : constr -> std_ppcmds (* = pr_lconstr *) +val prterm : constr -> std_ppcmds (** = pr_lconstr *) -(* spiwack: printer function for sets of Environ.assumption. +(** spiwack: printer function for sets of Environ.assumption. It is used primarily by the Print Assumption command. *) val pr_assumptionset : env -> Term.types Environ.ContextObjectMap.t ->std_ppcmds |
