package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
type container_page_pv = [
  1. | `Page of ContainerPage.t option * Names.PageName.t
]
and container_page = ContainerPage.t_pv id
type page_pv = [
  1. | ContainerPage.t_pv
  2. | `LeafPage of ContainerPage.t option * Names.PageName.t
]
and page = Page.t_pv id
type source_dir_pv = [
  1. | ContainerPage.t_pv
  2. | `SourceDir of SourceDir.t * string
]
and source_dir = SourceDir.t_pv id
type source_page_pv = [
  1. | `SourcePage of SourceDir.t * string
]

The second argument is the filename.

type source_page = SourcePage.t_pv id
type asset_file_pv = [
  1. | `AssetFile of Page.t * string
]

The second argument is the filename.

type asset_file = AssetFile.t_pv id
type source_location_pv = [
  1. | `SourceLocationMod of SourcePage.t
  2. | `SourceLocation of SourcePage.t * Names.DefName.t
  3. | `SourceLocationInternal of SourcePage.t * Names.LocalName.t
]
and source_location = SourceLocation.t id
type odoc_id_pv = [
  1. | Page.t_pv
  2. | `Root of ContainerPage.t option * Names.ModuleName.t
]
and odoc_id = OdocId.t_pv id
type signature_pv = [
  1. | `Root of ContainerPage.t option * Names.ModuleName.t
  2. | `Module of Signature.t * Names.ModuleName.t
  3. | `Parameter of Signature.t * Names.ModuleName.t
  4. | `Result of Signature.t
  5. | `ModuleType of Signature.t * Names.ModuleTypeName.t
]
and signature = Signature.t_pv id
type class_signature_pv = [
  1. | `Class of Signature.t * Names.ClassName.t
  2. | `ClassType of Signature.t * Names.ClassTypeName.t
]
and class_signature = ClassSignature.t_pv id
type datatype_pv = [
  1. | `Type of Signature.t * Names.TypeName.t
  2. | `CoreType of Names.TypeName.t
]
and datatype = DataType.t_pv id
type field_parent_pv = [
  1. | Signature.t_pv
  2. | DataType.t_pv
]
and field_parent = FieldParent.t_pv id
type label_parent_pv = [
  1. | FieldParent.t_pv
  2. | Page.t_pv
  3. | ClassSignature.t_pv
]
and label_parent = LabelParent.t_pv id
type root_module_pv = [
  1. | `Root of ContainerPage.t option * Names.ModuleName.t
]
and root_module = RootModule.t_pv id
type module_pv = [
  1. | RootModule.t_pv
  2. | `Module of Signature.t * Names.ModuleName.t
  3. | `Parameter of Signature.t * Names.ModuleName.t
]
and module_ = Module.t_pv id
type functor_parameter_pv = [
  1. | `Parameter of Signature.t * Names.ModuleName.t
]
and functor_parameter = FunctorParameter.t_pv id
type functor_result_pv = [
  1. | `Result of Signature.t
]
and functor_result = FunctorResult.t_pv id
type module_type_pv = [
  1. | `ModuleType of Signature.t * Names.ModuleTypeName.t
]
and module_type = ModuleType.t_pv id
type type_pv = [
  1. | `Type of Signature.t * Names.TypeName.t
  2. | `CoreType of Names.TypeName.t
]
and type_ = Type.t_pv id
type constructor_pv = [
  1. | `Constructor of DataType.t * Names.ConstructorName.t
]
and constructor = Constructor.t_pv id
type field_pv = [
  1. | `Field of FieldParent.t * Names.FieldName.t
]
and field = Field.t_pv id
type extension_pv = [
  1. | `Extension of Signature.t * Names.ExtensionName.t
]
type extension_decl_pv = [
  1. | `ExtensionDecl of Signature.t * Names.ExtensionName.t * Names.ExtensionName.t
]
and extension = Extension.t_pv id
and extension_decl = ExtensionDecl.t_pv id
type exception_pv = [
  1. | `Exception of Signature.t * Names.ExceptionName.t
  2. | `CoreException of Names.ExceptionName.t
]
and exception_ = Exception.t_pv id
type value_pv = [
  1. | `Value of Signature.t * Names.ValueName.t
]
and value = Value.t_pv id
type class_pv = [
  1. | `Class of Signature.t * Names.ClassName.t
]
and class_ = Class.t_pv id
type class_type_pv = [
  1. | `ClassType of Signature.t * Names.ClassTypeName.t
]
and class_type = ClassType.t_pv id
type method_pv = [
  1. | `Method of ClassSignature.t * Names.MethodName.t
]
and method_ = Method.t_pv id
type instance_variable_pv = [
  1. | `InstanceVariable of ClassSignature.t * Names.InstanceVariableName.t
]
and instance_variable = InstanceVariable.t_pv id
type label_pv = [
  1. | `Label of LabelParent.t * Names.LabelName.t
]
and label = Label.t_pv id
and non_src = NonSrc.t_pv id
and any = t_pv id
and path_module = Path.Module.t_pv id
type path_module_type = ModuleType.t
type path_type_pv = [
  1. | Type.t_pv
  2. | Class.t_pv
  3. | ClassType.t_pv
]
and path_type = Path.Type.t_pv id
type path_datatype_pv = Type.t_pv
and path_datatype = Path.DataType.t_pv id
type path_constructor = Constructor.t
type path_value = Value.t
type path_class_type_pv = [
  1. | Class.t_pv
  2. | ClassType.t_pv
]
and path_class_type = Path.ClassType.t_pv id
type fragment_module = Path.Module.t
type fragment_type = Path.Type.t
type reference_module = Path.Module.t
type reference_module_type = ModuleType.t
type reference_type = Path.Type.t
type reference_constructor = [ Constructor.t_pv | Extension.t_pv | Exception.t_pv ] id
type reference_field = Field.t
type reference_extension = [ Extension.t_pv | Exception.t_pv ] id
type reference_extension_decl = ExtensionDecl.t
type reference_exception = Exception.t
type reference_value = Value.t
type reference_class = Class.t
type reference_class_type = [ Class.t_pv | ClassType.t_pv ] id
type reference_method = Method.t
type reference_instance_variable = InstanceVariable.t
type reference_label = Label.t
type reference_page = Page.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct