doc-ock
  1. Overview
  2. Docs
package doc-ock
Legend:
Library
Module
Module type
Parameter
Class
Class type
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 -> 'a Element.signature_module
val find_apply_element : 'a t -> 'a Element.signature_module
val find_module_type_element : string -> 'a t -> 'a Element.signature_module_type
val find_type_element : string -> 'a t -> 'a Element.signature_type
val find_constructor_element : string -> 'a t -> 'a Element.signature_constructor
val find_field_element : string -> 'a t -> 'a Element.signature_field
val find_extension_element : string -> 'a t -> 'a Element.signature_extension
val find_exception_element : string -> 'a t -> 'a Element.signature_exception
val find_value_element : string -> 'a t -> 'a Element.signature_value
val find_class_element : string -> 'a t -> 'a Element.signature_class
val find_class_type_element : string -> 'a t -> 'a Element.signature_class_type
val find_label_element : string -> 'a t -> 'a Element.signature_label
val find_element : string -> 'a t -> 'a Element.signature
val find_section_title : string -> 'a t -> 'a DocOckTypes.Documentation.text

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 -> 'a 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 modules : 'a t -> (string * 'a t) list
val module_types : 'a t -> (string * 'a t) list
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 -> int) 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

Aliases handling

val set_canonical : 'a t -> ('a DocOckPaths.Path.module_ * 'a DocOckPaths.Reference.module_) option -> 'a t
val get_canonical : 'a t -> ('a DocOckPaths.Path.module_ * 'a DocOckPaths.Reference.module_) option

Hidding

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