Up

module DocOckComponents

: sig
#
module Sig : sig
#
type 'a t

Parents

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

Elements

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

Lookup

#
val lookup_module : string -> 'a t -> 'a t
#
val lookup_argument : int -> 'a t -> 'a t
#
val lookup_apply : ('a DocOckPaths.Path.module_ -> 'a t) -> 'a DocOckPaths.Path.module_ -> 'a t -> 'a t
#
val lookup_module_type : string -> 'a t -> 'a t
#
val lookup_class_type : string -> 'a t -> 'a ClassSig.t
#
val lookup_datatype : string -> 'a t -> 'a Datatype.t

Constructors

#
type 'a signature
#
val empty : 'a signature
#
val add_module : string -> 'a t -> 'a signature -> 'a signature
#
val add_module_type : string -> 'a t -> 'a signature -> 'a signature
#
val add_datatype : string -> 'a Datatype.t -> 'a signature -> 'a signature
#
val add_class : string -> 'a ClassSig.t -> 'a signature -> 'a signature
#
val add_class_type : string -> 'a ClassSig.t -> 'a signature -> 'a signature
#
val add_element : string -> Element.signature -> 'a signature -> 'a signature
#
val add_documentation : 'a DocOckTypes.Documentation.t -> 'a signature -> 'a signature
#
val add_comment : 'a DocOckTypes.Documentation.comment -> 'a signature -> 'a signature
#
val include_ : 'a t -> 'a signature -> 'a signature
#
val path : ('a DocOckPaths.Path.module_type -> 'a t) -> 'a DocOckPaths.Path.module_type -> 'a t
#
val alias : ('a DocOckPaths.Path.module_ -> 'a t) -> 'a DocOckPaths.Path.module_ -> 'a t
#
val signature : ('b -> 'a signature) -> 'b -> 'a t
#
val functor_ : ('a -> 'a -> bool) option -> ('a -> 'b) option -> 'a DocOckPaths.Identifier.module_ -> 'a t -> 'a t -> 'a t
#
val generative : 'a t -> 'a t
#
val abstract : 'a t
#
val unresolved : 'a t
#
val with_module : 'a DocOckPaths.Fragment.module_ -> 'a t -> 'a t -> 'a t
#
val with_module_subst : 'a DocOckPaths.Fragment.module_ -> 'a t -> 'a t
#
val with_type_subst : 'a DocOckPaths.Fragment.type_ -> 'a t -> 'a t
end
#
module Datatype : sig
#
type +'a t

Elements

#
val find_constructor_element : string -> 'a t -> Element.datatype_constructor
#
val find_field_element : string -> 'a t -> Element.datatype_field
#
val find_label_element : string -> 'a t -> Element.datatype_label
#
val find_element : string -> 'a t -> Element.datatype

Constructors

#
val add_documentation : 'a DocOckTypes.Documentation.t -> 'a t -> 'a t
#
val abstract : 'a t
#
val variant : string -> string list -> 'a t
#
val record : string -> string list -> 'a t
#
val extensible : 'a t
#
val unresolved : 'a t
end
#
module ClassSig : sig
#
type 'a t

Elements

#
val find_method_element : string -> 'a t -> Element.class_signature_method
#
val find_instance_variable_element : string -> 'a t -> Element.class_signature_instance_variable
#
val find_label_element : string -> 'a t -> Element.class_signature_label
#
val find_element : string -> 'a t -> Element.class_signature

Constructors

#
type 'a signature
#
val empty : 'a signature
#
val add_element : string -> Element.class_signature -> 'a signature -> 'a signature
#
val add_documentation : 'a DocOckTypes.Documentation.t -> 'a signature -> 'a signature
#
val add_comment : 'a DocOckTypes.Documentation.comment -> 'a signature -> 'a signature
#
val inherit_ : 'a t -> 'a signature -> 'a signature
#
val constr : ('a DocOckPaths.Path.class_type -> 'a t) -> 'a DocOckPaths.Path.class_type -> 'a t
#
val signature : ('b -> 'a signature) -> 'b -> 'a t
#
val unresolved : 'a t
end
#
module Parent : sig
#
type kind = DocOckPaths.Kind.parent
#
type ('a, 'b) t =
# | Module : 'a Sig.t -> ('a, [< > `Module ]) t
# | ModuleType : 'a Sig.t -> ('a, [< > `ModuleType ]) t
# | Datatype : 'a Datatype.t -> ('a, [< > `Type ]) t
# | Class : 'a ClassSig.t -> ('a, [< > `Class ]) t
# | ClassType : 'a ClassSig.t -> ('a, [< > `ClassType ]) t
#
type 'a signature = ('a, [
| `Module
| `ModuleType
]) t
#
type 'a class_signature = ('a, [
| `Class
| `ClassType
]) t
#
type 'a datatype = ('a, [
| `Type
]) t
#
type 'a module_ = ('a, [
| `Module
]) t
#
type 'a module_type = ('a, [
| `ModuleType
]) t
#
type 'a sig_or_type = ('a, [
| `Module
| `ModuleType
| `Type
]) t
#
type 'a any = ('a, kind) t
#
type 'a subst =
# | Subst of 'a DocOckPaths.Path.module_type
# | SubstAlias of 'a DocOckPaths.Path.module_
end
#
module Element : sig
#
type kind = [
| `Module
| `ModuleType
| `Type
| `Constructor
| `Field
| `Extension
| `Exception
| `Value
| `Class
| `ClassType
| `Method
| `InstanceVariable
| `Label
]
#
type 'a t =
# | Module : [< > `Module ] t
# | ModuleType : [< > `ModuleType ] t
# | Type : [< > `Type ] t
# | Constructor : string -> [< > `Constructor ] t
# | Field : string -> [< > `Field ] t
# | Extension : [< > `Extension ] t
# | Exception : [< > `Exception ] t
# | Value : [< > `Value ] t
# | Class : [< > `Class ] t
# | ClassType : [< > `ClassType ] t
# | Method : [< > `Method ] t
# | InstanceVariable : [< > `InstanceVariable ] t
# | Label : string option -> [< > `Label ] t
#
type signature_module = [
| `Module
] t
#
type signature_module_type = [
| `ModuleType
] t
#
type signature_type = [
| `Type
| `Class
| `ClassType
] t
#
type signature_constructor = [
| `Constructor
| `Extension
| `Exception
] t
#
type signature_field = [
| `Field
] t
#
type signature_extension = [
| `Extension
| `Exception
] t
#
type signature_exception = [
| `Exception
] t
#
type signature_value = [
| `Value
] t
#
type signature_class = [
| `Class
] t
#
type signature_class_type = [
| `Class
| `ClassType
] t
#
type signature_label = [
| `Label
] t
#
type signature = [
| `Module
| `ModuleType
| `Type
| `Constructor
| `Field
| `Extension
| `Exception
| `Value
| `Class
| `ClassType
| `Label
] t
#
type datatype_constructor = [
| `Constructor
] t
#
type datatype_field = [
| `Field
] t
#
type datatype_label = [
| `Label
] t
#
type datatype = [
| `Constructor
| `Field
| `Label
] t
#
type class_signature_method = [
| `Method
] t
#
type class_signature_instance_variable = [
| `InstanceVariable
] t
#
type class_signature_label = [
| `Label
] t
#
type class_signature = [
| `Method
| `InstanceVariable
| `Label
] t
end
end