Module Odoc_xref__Components.Sig

type t

Parents

val find_parent_module : string -> t -> Parent.module_
val find_parent_apply : (Odoc_model.Paths.Path.Module.t -> t) -> Odoc_model.Paths.Path.Module.t -> t -> Parent.module_
val find_parent_module_type : string -> t -> Parent.module_type
val find_parent_signature : string -> t -> Parent.signature
val find_parent_class_signature : string -> t -> Parent.class_signature
val find_parent_datatype : string -> t -> Parent.datatype
val find_parent_sig_or_type : string -> t -> Parent.sig_or_type
val find_parent_subst : t -> Parent.subst
val find_parent : string -> t -> Parent.any

Elements

val find_module_element : string -> t -> Element.signature_module
val find_apply_element : t -> Element.signature_module
val find_module_type_element : string -> t -> Element.signature_module_type
val find_type_element : string -> t -> Element.signature_type
val find_constructor_element : string -> t -> Element.signature_constructor
val find_field_element : string -> t -> Element.signature_field
val find_extension_element : string -> t -> Element.signature_extension
val find_exception_element : string -> t -> Element.signature_exception
val find_value_element : string -> t -> Element.signature_value
val find_class_element : string -> t -> Element.signature_class
val find_class_type_element : string -> t -> Element.signature_class_type
val find_label_element : string -> t -> Element.signature_label
val find_element : string -> t -> Element.signature
val find_section_title : string -> t -> Odoc_model.Comment.link_content

Lookup

val lookup_module : string -> t -> t
val lookup_argument : int -> t -> t
val lookup_apply : (Odoc_model.Paths.Path.Module.t -> t) -> Odoc_model.Paths.Path.Module.t -> t -> t
val lookup_module_type : string -> t -> t
val lookup_class_type : string -> t -> ClassSig.t
val lookup_datatype : string -> t -> Datatype.t

Constructors

type signature
val empty : signature
val add_module : string -> t -> signature -> signature
val add_module_type : string -> t -> signature -> signature
val add_datatype : string -> Datatype.t -> signature -> signature
val add_class : string -> ClassSig.t -> signature -> signature
val add_class_type : string -> ClassSig.t -> signature -> signature
val add_element : string -> Element.signature -> signature -> signature
val add_documentation : Odoc_model.Comment.docs -> signature -> signature
val add_comment : Odoc_model.Comment.docs_or_stop -> signature -> signature
val include_ : t -> signature -> signature
val modules : t -> (Odoc_model.Names.ModuleName.t * t) list
val module_types : t -> (Odoc_model.Names.ModuleTypeName.t * t) list
val path : (Odoc_model.Paths.Path.ModuleType.t -> t) -> Odoc_model.Paths.Path.ModuleType.t -> t
val alias : (Odoc_model.Paths.Path.Module.t -> t) -> Odoc_model.Paths.Path.Module.t -> t
val signature : ('b -> signature) -> 'b -> t
val functor_ : (Odoc_model.Root.t -> Odoc_model.Root.t -> bool) option -> (Odoc_model.Root.t -> int) option -> Odoc_model.Paths.Identifier.Module.t -> t -> t -> t
val generative : t -> t
val abstract : t
val unresolved : t
val with_module : Odoc_model.Paths.Fragment.Module.t -> t -> t -> t
val with_module_subst : Odoc_model.Paths.Fragment.Module.t -> t -> t
val with_type_subst : Odoc_model.Paths.Fragment.Type.t -> t -> t

Aliases handling

val set_canonical : t -> (Odoc_model.Paths.Path.Module.t * Odoc_model.Paths.Reference.Module.t) option -> t
val get_canonical : t -> (Odoc_model.Paths.Path.Module.t * Odoc_model.Paths.Reference.Module.t) option

Hidding

val set_hidden : t -> bool -> t
val get_hidden : t -> bool