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/indtypes.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/indtypes.mli')
| -rw-r--r-- | kernel/indtypes.mli | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/kernel/indtypes.mli b/kernel/indtypes.mli index 0cbe15034..c29e5475d 100644 --- a/kernel/indtypes.mli +++ b/kernel/indtypes.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 Names open Univ open Term @@ -16,13 +15,13 @@ open Declarations open Environ open Entries open Typeops -(*i*) -(*s The different kinds of errors that may result of a malformed inductive +(** {6 Sect } *) +(** The different kinds of errors that may result of a malformed inductive definition. *) -(* Errors related to inductive constructions *) +(** Errors related to inductive constructions *) type inductive_error = | NonPos of env * constr * constr | NotEnoughArgs of env * constr * constr @@ -37,7 +36,7 @@ type inductive_error = exception InductiveError of inductive_error -(*s The following function does checks on inductive declarations. *) +(** {6 The following function does checks on inductive declarations. } *) val check_inductive : env -> mutual_inductive_entry -> mutual_inductive_body |