ocaml-base-compiler 4.04.2

type ref_kind = Odoc_types.ref_kind =

| RK_module
| RK_module_type
| RK_class
| RK_class_type
| RK_value
| RK_type
| RK_extension
| RK_exception
| RK_attribute
| RK_method
| RK_section of text
| RK_recfield
| RK_const

and text_element = Odoc_types.text_element =

| Raw of string
| Code of string
| CodePre of string
| Verbatim of string
| Bold of text
| Italic of text
| Emphasize of text
| Center of text
| Left of text
| Right of text
| List of text list
| Enum of text list
| Newline
| Block of text
| Title of int * string option * text
| Latex of string
| Link of string * text
| Ref of string * ref_kind option * text option
| Superscript of text
| Subscript of text
| Module_list of string list
| Index_list
| Custom of string * text
| Target of string * string

and text = text_element list

type see_ref = Odoc_types.see_ref =

| See_url of string
| See_file of string
| See_doc of string

exception Text_syntax of int * int * string

type see = see_ref * text

type param = string * text

type raised_exception = string * text

type info = Odoc_types.info = {

i_desc : text option;
i_authors : string list;
i_version : string option;
i_sees : see list;
i_since : string option;
i_before : (string * text) list;
i_deprecated : text option;
i_params : param list;
i_raised_exceptions : raised_exception list;
i_return_value : text option;
i_custom : (string * text) list;

}

type location = Odoc_types.location = {

loc_impl : Location.t option;
loc_inter : Location.t option;

}

val dummy_loc : location

module Name : sig ... end

module Parameter : sig ... end

module Extension : sig ... end

module Exception : sig ... end

module Type : sig ... end

module Value : sig ... end

module Class : sig ... end

module Module : sig ... end

val reset_type_names : unit -> unit

val string_of_variance : Type.t_type -> (bool * bool) -> string

val string_of_type_expr : Types.type_expr -> string

val string_of_class_params : Class.t_class -> string

val string_of_type_list : ?par:bool -> string -> Types.type_expr list -> string

val string_of_type_param_list : Type.t_type -> string

val string_of_type_extension_param_list : Extension.t_type_extension -> string

val string_of_class_type_param_list : Types.type_expr list -> string

val string_of_module_type : 
  ?code:string ->
  ?complete:bool ->
  Types.module_type ->
  string

val string_of_class_type : ?complete:bool -> Types.class_type -> string

val string_of_text : text -> string

val string_of_info : info -> string

val string_of_type : Type.t_type -> string

val string_of_record : Type.record_field list -> string

val string_of_type_extension : Extension.t_type_extension -> string

val string_of_exception : Exception.t_exception -> string

val string_of_value : Value.t_value -> string

val string_of_attribute : Value.t_attribute -> string

val string_of_method : Value.t_method -> string

val first_sentence_of_text : text -> text

val first_sentence_and_rest_of_text : text -> text * text

val text_no_title_no_list : text -> text

val text_concat : Odoc_types.text -> Odoc_types.text list -> Odoc_types.text

val get_titles_in_text : text -> (int * string option * text) list

val create_index_lists : 'a list -> ('a -> string) -> 'a list list

val remove_option : Types.type_expr -> Types.type_expr

val is_optional : Asttypes.arg_label -> bool

val label_name : Asttypes.arg_label -> string

val use_hidden_modules : Name.t -> Name.t

val verbose : string -> unit

val warning : string -> unit

val print_warnings : bool Pervasives.ref

val errors : int Pervasives.ref

val apply_opt : ('a -> 'b) -> 'a option -> 'b option

val apply_if_equal : ('a -> 'a) -> 'a -> 'a -> 'a

val text_of_string : string -> text

val text_string_of_text : text -> string

val info_of_string : string -> info

val info_string_of_info : info -> string

val info_of_comment_file : Module.t_module list -> string -> info

val remove_ending_newline : string -> string

module Search : sig ... end

module Scan : sig ... end

module Dep : sig ... end

module Global : sig ... end

val analyse_files : 
  ?merge_options:Odoc_types.merge_option list ->
  ?include_dirs:string list ->
  ?labels:bool ->
  ?sort_modules:bool ->
  ?no_stop:bool ->
  ?init:Odoc_module.t_module list ->
  Odoc_global.source_file list ->
  Module.t_module list

val dump_modules : string -> Odoc_module.t_module list -> unit

val load_modules : string -> Odoc_module.t_module list

package ocaml-base-compiler