package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (4)

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.0.0.tbz
sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b
sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

doc/odoc.model/Odoc_model/Paths/Identifier/Id/index.html

Module Identifier.IdSource

Sourcetype container_page_pv = [
  1. | `Page of ContainerPage.t option * Names.PageName.t
]
Sourceand container_page = ContainerPage.t_pv id
Sourcetype leaf_page_pv = [
  1. | `LeafPage of ContainerPage.t option * Names.PageName.t
]
Sourceand leaf_page = LeafPage.t_pv id
Sourcetype page_pv = [
  1. | ContainerPage.t_pv
  2. | LeafPage.t_pv
]
Sourceand page = Page.t_pv id
Sourcetype source_page_pv = [
  1. | `SourcePage of ContainerPage.t * string
]

The second argument is the filename.

Sourcetype source_page = SourcePage.t_pv id
Sourcetype asset_file_pv = [
  1. | `AssetFile of Page.t * Names.AssetName.t
]

The second argument is the filename.

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