summaryrefslogtreecommitdiffstats
path: root/ocamldoc/odoc_analyse.mli
blob: 5e45e50a23250ef2e25fdaec990cf05a981c0434 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
(***********************************************************************)
(*                                                                     *)
(*                             OCamldoc                                *)
(*                                                                     *)
(*            Maxence Guesdon, projet Cristal, INRIA Rocquencourt      *)
(*                                                                     *)
(*  Copyright 2001 Institut National de Recherche en Informatique et   *)
(*  en Automatique.  All rights reserved.  This file is distributed    *)
(*  under the terms of the Q Public License version 1.0.               *)
(*                                                                     *)
(***********************************************************************)

(* $Id$ *)

(** Analysis of source files. *)

(** This function builds the top modules from the analysis of the
   given list of source files.
   @param init is the list of modules already known from a previous analysis.
*)
val analyse_files :
    ?init: Odoc_module.t_module list ->
      Odoc_global.source_file list ->
        Odoc_module.t_module list

(** Dump of a list of modules into a file.
   @raise Failure if an error occurs.*)
val dump_modules : string -> Odoc_module.t_module list -> unit

(** Load of a list of modules from a file.
   @raise Failure if an error occurs.*)
val load_modules : string -> Odoc_module.t_module list