l4/pkg/ocaml/contrib/ocamldoc/odoc_analyse.mli

   1 (***********************************************************************)
   2 (*                             OCamldoc                                *)
   3 (*                                                                     *)
   4 (*            Maxence Guesdon, projet Cristal, INRIA Rocquencourt      *)
   5 (*                                                                     *)
   6 (*  Copyright 2001 Institut National de Recherche en Informatique et   *)
   7 (*  en Automatique.  All rights reserved.  This file is distributed    *)
   8 (*  under the terms of the Q Public License version 1.0.               *)
   9 (*                                                                     *)
  10 (***********************************************************************)
  11
  12 (* $Id: odoc_analyse.mli 6612 2004-08-20 17:04:35Z doligez $ *)
  13
  14 (** Analysis of source files. *)
  15
  16 (** This function builds the top modules from the analysis of the
  17    given list of source files.
  18    @param init is the list of modules already known from a previous analysis.
  19 *)
  20 val analyse_files :
  21     ?init: Odoc_module.t_module list ->
  22       Odoc_args.source_file list ->
  23         Odoc_module.t_module list
  24
  25 (** Dump of a list of modules into a file.
  26    @raise Failure if an error occurs.*)
  27 val dump_modules : string -> Odoc_module.t_module list -> unit
  28
  29 (** Load of a list of modules from a file.
  30    @raise Failure if an error occurs.*)
  31 val load_modules : string -> Odoc_module.t_module list
  32