doc-ock
  1. Overview
  2. Docs
package doc-ock
Legend:
Library
Module
Module type
Parameter
Class
Class type
type kind = Kind.reference
type ('a, 'b) t =
  1. | Identifier : ('a, 'b) Identifier.t -> ('a, 'b) t
  2. | SubstAlias : 'a Path.Resolved.module_ * 'a module_ -> ('a, [< kind Module ]) t
  3. | Module : 'a signature * string -> ('a, [< kind Module ]) t
  4. | Canonical : 'a module_ * 'a Reference.module_ -> ('a, [< kind Module ]) t
  5. | ModuleType : 'a signature * string -> ('a, [< kind ModuleType ]) t
  6. | Type : 'a signature * string -> ('a, [< kind Type ]) t
  7. | Constructor : 'a datatype * string -> ('a, [< kind Constructor ]) t
  8. | Field : 'a parent * string -> ('a, [< kind Field ]) t
  9. | Extension : 'a signature * string -> ('a, [< kind Extension ]) t
  10. | Exception : 'a signature * string -> ('a, [< kind Exception ]) t
  11. | Value : 'a signature * string -> ('a, [< kind Value ]) t
  12. | Class : 'a signature * string -> ('a, [< kind Class ]) t
  13. | ClassType : 'a signature * string -> ('a, [< kind ClassType ]) t
  14. | Method : 'a class_signature * string -> ('a, [< kind Method ]) t
  15. | InstanceVariable : 'a class_signature * string -> ('a, [< kind InstanceVariable ]) t
  16. | Label : 'a label_parent * string -> ('a, [< kind Label ]) t
and 'a any = ('a, kind) t
and 'a signature = ('a, Kind.signature) t
and 'a class_signature = ('a, Kind.class_signature) t
and 'a datatype = ('a, Kind.datatype) t
and 'a parent = ('a, Kind.parent) t
and 'a module_ = ('a, Kind.reference_module) t
and 'a label_parent = ('a, Kind.label_parent) t
type 'a module_type = ('a, Kind.reference_module_type) t
type 'a type_ = ('a, Kind.reference_type) t
type 'a constructor = ('a, Kind.reference_constructor) t
type 'a field = ('a, Kind.reference_field) t
type 'a extension = ('a, Kind.reference_extension) t
type 'a exception_ = ('a, Kind.reference_exception) t
type 'a value = ('a, Kind.reference_value) t
type 'a class_ = ('a, Kind.reference_class) t
type 'a class_type = ('a, Kind.reference_class_type) t
type 'a method_ = ('a, Kind.reference_method) t
type 'a instance_variable = ('a, Kind.reference_instance_variable) t
type 'a label = ('a, Kind.reference_label) t
type 'a page = ('a, Kind.reference_page) t

Creators

val ident_module : 'a Identifier.module_ -> ('a, [< kind Module ]) t
val ident_module_type : 'a Identifier.module_type -> ('a, [< kind ModuleType ]) t
val ident_type : 'a Identifier.type_ -> ('a, [< kind Type ]) t
val ident_constructor : 'a Identifier.constructor -> ('a, [< kind Constructor ]) t
val ident_field : 'a Identifier.field -> ('a, [< kind Field ]) t
val ident_extension : 'a Identifier.extension -> ('a, [< kind Extension ]) t
val ident_exception : 'a Identifier.exception_ -> ('a, [< kind Exception ]) t
val ident_value : 'a Identifier.value -> ('a, [< kind Value ]) t
val ident_class : 'a Identifier.class_ -> ('a, [< kind Class ]) t
val ident_class_type : 'a Identifier.class_type -> ('a, [< kind ClassType ]) t
val ident_method : 'a Identifier.method_ -> ('a, [< kind Method ]) t
val ident_instance_variable : 'a Identifier.instance_variable -> ('a, [< kind InstanceVariable ]) t
val ident_label : 'a Identifier.label -> ('a, [< kind Label ]) t
val ident_page : 'a Identifier.page -> ('a, [< kind Page ]) t

Explicit coercions

val signature_of_module : 'a module_ -> 'a signature
val signature_of_module_type : 'a module_type -> 'a signature
val class_signature_of_class : 'a class_ -> 'a class_signature
val class_signature_of_class_type : 'a class_type -> 'a class_signature
val parent_of_signature : 'a signature -> 'a parent
val parent_of_class_signature : 'a class_signature -> 'a parent
val parent_of_datatype : 'a datatype -> 'a parent
val label_parent_of_parent : 'a parent -> 'a label_parent
val label_parent_of_page : 'a page -> 'a label_parent
val any : ('a, 'b) t -> 'a any

Generic operations

val equal : equal:('a -> 'a -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool
val hash : hash:('a -> int) -> ('a, 'b) t -> int
val identifier : ('a, 'b) t -> ('a, 'b) Identifier.t

identifier rr extracts the identifier present at the "root" of rr.

val rebase : 'a Identifier.signature -> ('a, 'b) t -> ('a, 'b) t
val sexp_of_t : ('a -> sexp) -> ('a, _) t -> sexp