Module Odoc_module

module String = Misc.Stdlib.String
module Name = Odoc_name
type module_element =
  1. | Element_module of t_module
  2. | Element_module_type of t_module_type
  3. | Element_included_module of included_module
  4. | Element_class of Odoc_class.t_class
  5. | Element_class_type of Odoc_class.t_class_type
  6. | Element_value of Odoc_value.t_value
  7. | Element_type_extension of Odoc_extension.t_type_extension
  8. | Element_exception of Odoc_exception.t_exception
  9. | Element_type of Odoc_type.t_type
  10. | Element_module_comment of Odoc_types.text
and mmt =
  1. | Mod of t_module
  2. | Modtype of t_module_type
and included_module = {
  1. im_name : Name.t;
  2. mutable im_module : mmt option;
  3. mutable im_info : Odoc_types.info option;
}
and module_alias = {
  1. ma_name : Name.t;
  2. mutable ma_module : mmt option;
}
and module_parameter = {
  1. mp_name : string;
  2. mp_type : Types.module_type option;
  3. mp_type_code : string;
  4. mp_kind : module_type_kind;
}
and module_kind =
  1. | Module_struct of module_element list
  2. | Module_alias of module_alias
  3. | Module_functor of module_parameter * module_kind
  4. | Module_apply of module_kind * module_kind
  5. | Module_apply_unit of module_kind
  6. | Module_with of module_type_kind * string
  7. | Module_constraint of module_kind * module_type_kind
  8. | Module_typeof of string
  9. | Module_unpack of string * module_type_alias
and t_module = {
  1. m_name : Name.t;
  2. mutable m_type : Types.module_type;
  3. mutable m_info : Odoc_types.info option;
  4. m_is_interface : bool;
  5. m_file : string;
  6. mutable m_kind : module_kind;
  7. mutable m_loc : Odoc_types.location;
  8. mutable m_top_deps : Name.t list;
  9. mutable m_code : string option;
  10. mutable m_code_intf : string option;
  11. m_text_only : bool;
}
and module_type_alias = {
  1. mta_name : Name.t;
  2. mutable mta_module : t_module_type option;
}
and module_type_kind =
  1. | Module_type_struct of module_element list
  2. | Module_type_functor of module_parameter * module_type_kind
  3. | Module_type_alias of module_type_alias
  4. | Module_type_with of module_type_kind * string
  5. | Module_type_typeof of string
and t_module_type = {
  1. mt_name : Name.t;
  2. mutable mt_info : Odoc_types.info option;
  3. mutable mt_type : Types.module_type option;
  4. mt_is_interface : bool;
  5. mt_file : string;
  6. mutable mt_kind : module_type_kind option;
  7. mutable mt_loc : Odoc_types.location;
}
val values : module_element list -> Odoc_value.t_value list
val types : module_element list -> Odoc_type.t_type list
val type_extensions : module_element list -> Odoc_extension.t_type_extension list
val exceptions : module_element list -> Odoc_exception.t_exception list
val classes : module_element list -> Odoc_class.t_class list
val class_types : module_element list -> Odoc_class.t_class_type list
val modules : module_element list -> t_module list
val mod_types : module_element list -> t_module_type list
val comments : module_element list -> Odoc_types.text list
val included_modules : module_element list -> included_module list
val module_type_elements : ?trans:bool -> t_module_type -> module_element list
val module_elements : ?trans:bool -> t_module -> module_element list
val module_values : ?trans:bool -> t_module -> Odoc_value.t_value list
val module_functions : ?trans:bool -> t_module -> Odoc_value.t_value list
val module_simple_values : ?trans:bool -> t_module -> Odoc_value.t_value list
val module_types : ?trans:bool -> t_module -> Odoc_type.t_type list
val module_type_extensions : ?trans:bool -> t_module -> Odoc_extension.t_type_extension list
val module_exceptions : ?trans:bool -> t_module -> Odoc_exception.t_exception list
val module_classes : ?trans:bool -> t_module -> Odoc_class.t_class list
val module_class_types : ?trans:bool -> t_module -> Odoc_class.t_class_type list
val module_modules : ?trans:bool -> t_module -> t_module list
val module_module_types : ?trans:bool -> t_module -> t_module_type list
val module_included_modules : ?trans:bool -> t_module -> included_module list
val module_comments : ?trans:bool -> t_module -> Odoc_types.text list
val module_type_parameters : ?trans:bool -> t_module_type -> (module_parameter * Odoc_types.text option) list
val module_parameters : ?trans:bool -> t_module -> (module_parameter * Odoc_types.text option) list
val module_all_submodules : ?trans:bool -> t_module -> t_module list
val module_type_is_functor : t_module_type -> bool
val module_is_functor : t_module -> bool
val module_type_values : ?trans:bool -> t_module_type -> Odoc_value.t_value list
val module_type_types : ?trans:bool -> t_module_type -> Odoc_type.t_type list
val module_type_type_extensions : ?trans:bool -> t_module_type -> Odoc_extension.t_type_extension list
val module_type_exceptions : ?trans:bool -> t_module_type -> Odoc_exception.t_exception list
val module_type_classes : ?trans:bool -> t_module_type -> Odoc_class.t_class list
val module_type_class_types : ?trans:bool -> t_module_type -> Odoc_class.t_class_type list
val module_type_modules : ?trans:bool -> t_module_type -> t_module list
val module_type_module_types : ?trans:bool -> t_module_type -> t_module_type list
val module_type_included_modules : ?trans:bool -> t_module_type -> included_module list
val module_type_comments : ?trans:bool -> t_module_type -> Odoc_types.text list
val module_type_functions : ?trans:bool -> t_module_type -> Odoc_value.t_value list
val module_type_simple_values : ?trans:bool -> t_module_type -> Odoc_value.t_value list
val module_all_classes : ?trans:bool -> t_module -> Odoc_class.t_class list
val module_type_all_classes : ?trans:bool -> t_module_type -> Odoc_class.t_class list