From f73d7c4614d000f068550b5144d80b7eceed58e9 Mon Sep 17 00:00:00 2001
From: pboutill <pboutill@85f007b7-540e-0410-9357-904b9bb8a0f7>
Date: Thu, 29 Apr 2010 09:56:37 +0000
Subject: 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
---
 toplevel/ind_tables.mli | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

(limited to 'toplevel/ind_tables.mli')

diff --git a/toplevel/ind_tables.mli b/toplevel/ind_tables.mli
index 57ebbcda1..2abd15ce3 100644
--- a/toplevel/ind_tables.mli
+++ b/toplevel/ind_tables.mli
@@ -1,10 +1,10 @@
-(************************************************************************)
-(*  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        
+  ***********************************************************************)
 
 open Term
 open Names
@@ -13,10 +13,10 @@ open Mod_subst
 open Sign
 open Declarations
 
-(* This module provides support for registering inductive scheme builders,
+(** This module provides support for registering inductive scheme builders,
    declaring schemes and generating schemes on demand *)
 
-(* A scheme is either a "mutual scheme_kind" or an "individual scheme_kind" *)
+(** A scheme is either a "mutual scheme_kind" or an "individual scheme_kind" *)
 
 type mutual
 type individual
@@ -25,7 +25,7 @@ type 'a scheme_kind
 type mutual_scheme_object_function = mutual_inductive -> constr array
 type individual_scheme_object_function = inductive -> constr
 
-(* Main functions to register a scheme builder *)
+(** Main functions to register a scheme builder *)
 
 val declare_mutual_scheme_object : string -> ?aux:string ->
   mutual_scheme_object_function -> mutual scheme_kind
@@ -37,15 +37,15 @@ val declare_individual_scheme_object : string -> ?aux:string ->
 val declare_scheme : 'a scheme_kind -> (inductive * constant) array -> unit
 *)
 
-(* Force generation of a (mutually) scheme with possibly user-level names *)
+(** Force generation of a (mutually) scheme with possibly user-level names *)
 
-val define_individual_scheme : individual scheme_kind -> bool (* internal *) ->
+val define_individual_scheme : individual scheme_kind -> bool (** internal *) ->
   identifier option -> inductive -> constant
 
-val define_mutual_scheme : mutual scheme_kind -> bool (* internal *) ->
+val define_mutual_scheme : mutual scheme_kind -> bool (** internal *) ->
   (int * identifier) list -> mutual_inductive -> constant array
 
-(* Main function to retrieve a scheme in the cache or to generate it *)
+(** Main function to retrieve a scheme in the cache or to generate it *)
 val find_scheme : 'a scheme_kind -> inductive -> constant
 
 val check_scheme : 'a scheme_kind -> inductive -> bool
-- 
cgit v1.2.3