Paths

Edit

Paths of documentation

other items defined

module Kind : Kind

module Identifier

Identifiers for definitions

other items defined

include

type kind = identifier

type t('kind) = | Root(Root.t, string): t([< kind > `Module ]) | Page(Root.t, string): t([< kind > `Page ]) | Module(signature, string): t([< kind > `Module ]) | Argument(signature, int, string): t( [< kind > `Module ] ) | ModuleType(signature, string): t( [< kind > `ModuleType ] ) | Type(signature, string): t([< kind > `Type ]) | CoreType(string): t([< kind > `Type ]) | Constructor(datatype, string): t( [< kind > `Constructor ] ) | Field(parent, string): t([< kind > `Field ]) | Extension(signature, string): t( [< kind > `Extension ] ) | Exception(signature, string): t( [< kind > `Exception ] ) | CoreException(string): t([< kind > `Exception ]) | Value(signature, string): t([< kind > `Value ]) | Class(signature, string): t([< kind > `Class ]) | ClassType(signature, string): t( [< kind > `ClassType ] ) | Method(class_signature, string): t( [< kind > `Method ] ) | InstanceVariable(class_signature, string): t( [< kind > `InstanceVariable ] ) | Label(label_parent, string): t([< kind > `Label ])

type any = t(kind)

type signature = t(signature)

type class_signature = t(class_signature)

type datatype = t(datatype)

type parent = t(parent)

type label_parent = t(label_parent)

type module_ = t(identifier_module)

type module_type = t(identifier_module_type)

type type_ = t(identifier_type)

type constructor = t(identifier_constructor)

type field = t(identifier_field)

type extension = t(identifier_extension)

type exception_ = t(identifier_exception)

type value = t(identifier_value)

type class_ = t(identifier_class)

type class_type = t(identifier_class_type)

type method_ = t(identifier_method)

type instance_variable = t(identifier_instance_variable)

type label = t(identifier_label)

type page = t(identifier_page)

type path_module = t(path_module)

type path_module_type = t(path_module_type)

type path_type = t(path_type)

type path_class_type = t(path_class_type)

type fragment_module = t(fragment_module)

type fragment_type = t(fragment_type)

type reference_module = t(reference_module)

type reference_module_type = t(reference_module_type)

type reference_type = t(reference_type)

type reference_constructor = t(reference_constructor)

type reference_field = t(reference_field)

type reference_extension = t(reference_extension)

type reference_exception = t(reference_exception)

type reference_value = t(reference_value)

type reference_class = t(reference_class)

type reference_class_type = t(reference_class_type)

type reference_method = t(reference_method)

type reference_instance_variable = t( reference_instance_variable )

type reference_label = t(reference_label)

type reference_page = t(reference_page)

Explicit coercions

let signature_of_module: module_ => signature

let signature_of_module_type: module_type => signature

let class_signature_of_class: class_ => class_signature

let class_signature_of_class_type: class_type => class_signature

let datatype_of_type: type_ => datatype

let parent_of_signature: signature => parent

let parent_of_class_signature: class_signature => parent

let parent_of_datatype: datatype => parent

let label_parent_of_parent: parent => label_parent

let label_parent_of_page: page => label_parent

let any: t('kind) => any

Generic operations

let equal: (t('kind), t('kind)) => bool

let hash: t('kind) => int

Printing

let name: t('kind) => string

Root retrieval

let signature_root: signature => Root.t

let module_root: module_ => Root.t

let module_type_root: module_type => Root.t

let class_signature_root: class_signature => Root.t

let label_parent_root: label_parent => Root.t

module Fragment

OCaml path fragments for specifying module substitutions

other items defined

module Resolved

This module does not have a toplevel documentation block.

include

type kind = fragment

type sort = [ `Branch | `Root ]

type raw('b, 'c) = | Root: raw('b, [< sort > `Root ]) | Subst(module_type, module_): raw( [< kind > `Module ], [< sort > `Branch ] ) | SubstAlias(module_, module_): raw( [< kind > `Module ], [< sort > `Branch ] ) | Module(signature, string): raw( [< kind > `Module ], [< sort > `Branch ] ) | Type(signature, string): raw( [< kind > `Type ], [< sort > `Branch ] ) | Class(signature, string): raw( [< kind > `Class ], [< sort > `Branch ] ) | ClassType(signature, string): raw( [< kind > `ClassType ], [< sort > `Branch ] )

type t('b) = raw('b, [ `Branch ])

type any = t(kind)

type signature = raw(fragment_module, [ `Branch | `Root ])

type module_ = t(fragment_module)

type type_ = t(fragment_type)

Explicit coercions

let signature_of_module: module_ => signature

let any: t('b) => any

let any_sort: raw('b, 'c) => raw('b, sort)

Attaching fragments to valid paths

let path: (Path.module_, t('b)) => Path.t('b)

let identifier: (signature, t('b)) => Identifier.t('b)

Generic operations

let equal: (t('b), t('b)) => bool

let hash: t('b) => int

let split: t('b) => (string, option(t('b)))

include

type kind = fragment

type sort = [ `Branch | `Root ]

type raw('b, 'c) = | Resolved(raw('b, 'c)): raw('b, 'c) | Dot(signature, string): raw( [< kind ], [< sort > `Branch ] )

type t('b) = raw('b, [ `Branch ])

type any = t(kind)

type signature = raw(fragment_module, [ `Branch | `Root ])

type module_ = t(fragment_module)

type type_ = t(fragment_type)

Explicit coercions

let signature_of_module: module_ => signature

let any_sort: raw('b, 'c) => raw('b, sort)

let any: t('b) => any

Attaching fragments to valid paths

let path: (Path.module_, t('b)) => Path.t('b)

Generic operations

let equal: (t('b), t('b)) => bool

let hash: t('b) => int

let split: t('b) => (string, option(t('b)))