ocamldoc/odoc_merge.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$ *)
  13
  14 (** Merge of information from [.ml] and [.mli] for a module.*)
  15
  16 (** Merge of two optional info structures.
  17    Used to merge a comment before and a comment after
  18    an element in [Odoc_sig.Analyser.analyse_signature_item_desc]. *)
  19 val merge_info_opt :
  20     Odoc_types.merge_option list ->
  21       Odoc_types.info option ->
  22         Odoc_types.info option ->
  23           Odoc_types.info option
  24
  25 (** Merge of modules which represent the same OCaml module, in a list of t_module.
  26    There must be at most two t_module for the same OCaml module, one for a .mli, another for the .ml.
  27    The function returns the list of t_module where same modules have been merged, according
  28    to the given merge_option list.*)
  29 val merge :
  30   Odoc_types.merge_option list ->
  31   Odoc_module.t_module list -> Odoc_module.t_module list
  32