Module Odoc_xref__Component_table
Tables
type lookup_result_found
=
{
root : Odoc_model.Root.t;
}
type lookup_unit_result
=
|
Forward_reference
|
Found of lookup_result_found
|
Not_found
val create : ?equal:(Odoc_model.Root.t -> Odoc_model.Root.t -> bool) -> ?hash:(Odoc_model.Root.t -> int) -> (string -> lookup_unit_result) -> (Odoc_model.Root.t -> Odoc_model.Lang.Compilation_unit.t) -> (string -> Odoc_model.Root.t option) -> (Odoc_model.Root.t -> Odoc_model.Lang.Page.t) -> t
Create a table of the components of units. Optionally provide equality and hash functons.
Identifier Lookup
val signature_identifier : t -> Odoc_model.Paths.Identifier.Signature.t -> Odoc_xref__.Components.Sig.t
Lookup the components of a signature identifier
val class_signature_identifier : t -> Odoc_model.Paths.Identifier.ClassSignature.t -> Odoc_xref__.Components.ClassSig.t
Lookup the components of a class signature identifier
val datatype_identifier : t -> Odoc_model.Paths.Identifier.Type.t -> Odoc_xref__.Components.Datatype.t
Lookup the components of a datatype identifier
Path Lookup
val resolved_module_path : t -> Odoc_model.Paths.Path.Resolved.Module.t -> Odoc_xref__.Components.Sig.t
Lookup the components of a resolved module path
val resolved_module_type_path : t -> Odoc_model.Paths.Path.Resolved.ModuleType.t -> Odoc_xref__.Components.Sig.t
Lookup the components of a resolved module type path
val resolved_class_type_path : t -> Odoc_model.Paths.Path.Resolved.ClassType.t -> Odoc_xref__.Components.ClassSig.t
Lookup the components of a resolved class type path
val module_path : t -> Odoc_model.Paths.Path.Module.t -> Odoc_xref__.Components.Sig.t
Lookup the components of a module path, needed for module applications.
Fragment Lookup
val module_type_expr_with : t -> Odoc_model.Paths.Identifier.Signature.t -> Odoc_model.Lang.ModuleType.expr -> with_
Create specialised fragment table for a module type expression
val module_type_path_with : t -> Odoc_model.Paths.Path.ModuleType.t -> with_
Create specialised fragment table for a module path
val resolved_signature_fragment : with_ -> Odoc_model.Paths.Fragment.Resolved.Signature.t -> Odoc_xref__.Components.Sig.t
Lookup the components of a resolved module fragment
Reference Lookup
val resolved_signature_reference : t -> Odoc_model.Paths.Reference.Resolved.Signature.t -> Odoc_xref__.Components.Sig.t
Lookup the components of a resolved signature reference
val resolved_class_signature_reference : t -> Odoc_model.Paths.Reference.Resolved.ClassSignature.t -> Odoc_xref__.Components.ClassSig.t
Lookup the components of a resolved class signature reference
val resolved_datatype_reference : t -> Odoc_model.Paths.Reference.Resolved.DataType.t -> Odoc_xref__.Components.Datatype.t
Lookup the components of a resolved datatype reference
val resolved_page_reference : t -> Odoc_model.Paths.Reference.Resolved.Page.t -> Odoc_xref__.Components.Page.t
Root lookup
val base : t -> string -> lookup_unit_result
Lookup the base of a unit name
val page_base : t -> string -> Odoc_model.Root.t option
Lookup the base of a page name