summaryrefslogtreecommitdiff
path: root/ocamldoc/odoc_exception.mli
blob: 52e85bdf90e68d8042973f52acc41716750cfa61 (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
33
34
35
36
(**************************************************************************)
(*                                                                        *)
(*                                 OCaml                                  *)
(*                                                                        *)
(*             Sebastien Hinderer, projet Cambium, INRIA Paris            *)
(*                                                                        *)
(*   Copyright 2022 Institut National de Recherche en Informatique et     *)
(*     en Automatique.                                                    *)
(*                                                                        *)
(*   All rights reserved.  This file is distributed under the terms of    *)
(*   the GNU Lesser General Public License version 2.1, with the          *)
(*   special exception on linking described in the file LICENSE.          *)
(*                                                                        *)
(**************************************************************************)

(** Representation and manipulation of exceptions. *)

(** This module has an implementation although it declares only types.
    This is because other modules use the let module construct ot access it
    so it is needed as a real module. *)

module Name = Odoc_name

type exception_alias = {
  ea_name : Name.t;
  mutable ea_ex : t_exception option;
}
and t_exception = {
  ex_name : Name.t;
  mutable ex_info : Odoc_types.info option;
  ex_args : Odoc_type.constructor_args;
  ex_ret : Types.type_expr option;
  ex_alias : exception_alias option;
  mutable ex_loc : Odoc_types.location;
  mutable ex_code : string option;
}