Analyser (ocaml.Odoc_sig.Analyser)

Parameters

module _ : Info_retriever

Signature

val file : string ref

val file_name : string ref

val get_string_of_file : int -> int -> string

val prepare_file : string -> string -> unit

val preamble : 
  string ->
  string ->
  ('a -> Location.t) ->
  'a list ->
  int * Odoc_types.info option

val get_comments_in_class : 
  int ->
  int ->
  Odoc_types.info option * Odoc_class.class_element list

val get_comments_in_module : 
  int ->
  int ->
  Odoc_types.info option * Odoc_module.module_element list

val name_comment_from_type_decl : 
  int ->
  int ->
  Parsetree.type_declaration ->
  int * (string * Odoc_types.info option) list

val manifest_structure : 
  Odoc_env.env ->
  (string * Odoc_types.info option) list ->
  Types.type_expr ->
  Odoc_type.type_manifest

val get_type_kind : 
  Odoc_env.env ->
  (string * Odoc_types.info option) list ->
  Types.type_decl_kind ->
  Odoc_type.type_kind

val get_cstr_args : 
  Odoc_env.env ->
  int ->
  Typedtree.constructor_arguments ->
  Odoc_type.constructor_args

val merge_infos : 
  Odoc_types.info option ->
  Odoc_types.info option ->
  Odoc_types.info option

val analyse_module_type_kind : 
  ?erased:
    [ `Constrained of Parsetree.with_constraint list | `Removed ]
      Odoc_name.Map.t ->
  Odoc_env.env ->
  Odoc_name.t ->
  Parsetree.module_type ->
  Types.module_type ->
  Odoc_module.module_type_kind

val analyse_class_type_kind : 
  Odoc_env.env ->
  Odoc_name.t ->
  int ->
  Parsetree.class_type ->
  Types.class_type ->
  Odoc_class.class_type_kind

val analyse_signature : 
  string ->
  string ->
  Parsetree.signature ->
  Types.signature ->
  Odoc_module.t_module