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.1.0.tbz
sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914
sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05

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

Module Identifier.MkSource

Sourceval page : (ContainerPage.t option * Names.PageName.t) -> [> `Page of ContainerPage.t option * Names.PageName.t ] id
Sourceval leaf_page : (ContainerPage.t option * Names.PageName.t) -> [> `LeafPage of ContainerPage.t option * Names.PageName.t ] id
Sourceval source_page : (ContainerPage.t * string) -> SourcePage.t
Sourceval root : (ContainerPage.t option * Names.ModuleName.t) -> [> `Root of ContainerPage.t option * Names.ModuleName.t ] id
Sourceval implementation : string -> [> `Implementation of Names.ModuleName.t ] id
Sourceval module_ : (Signature.t * Names.ModuleName.t) -> [> `Module of Signature.t * Names.ModuleName.t ] id
Sourceval parameter : (Signature.t * Names.ModuleName.t) -> [> `Parameter of Signature.t * Names.ModuleName.t ] id
Sourceval result : Signature.t -> [> `Result of Signature.t ] id
Sourceval module_type : (Signature.t * Names.ModuleTypeName.t) -> [> `ModuleType of Signature.t * Names.ModuleTypeName.t ] id
Sourceval class_ : (Signature.t * Names.TypeName.t) -> [> `Class of Signature.t * Names.TypeName.t ] id
Sourceval class_type : (Signature.t * Names.TypeName.t) -> [> `ClassType of Signature.t * Names.TypeName.t ] id
Sourceval type_ : (Signature.t * Names.TypeName.t) -> [> `Type of Signature.t * Names.TypeName.t ] id
Sourceval core_type : string -> [> `CoreType of Names.TypeName.t ] id
Sourceval constructor : (DataType.t * Names.ConstructorName.t) -> [> `Constructor of DataType.t * Names.ConstructorName.t ] id
Sourceval extension : (Signature.t * Names.ExtensionName.t) -> [> `Extension of Signature.t * Names.ExtensionName.t ] id

extension_decl (sg, e1, eN) defines an extension declaration where sg is the parent, e1 is the first constructor of the extension, and eN is the constructor the Id is created for. e1 will be used for the url, and eN will be the one displayed. The first constructor of the extension will always be used to reference the extension point.

Sourceval exception_ : (Signature.t * Names.ExceptionName.t) -> [> `Exception of Signature.t * Names.ExceptionName.t ] id
Sourceval method_ : (ClassSignature.t * Names.MethodName.t) -> [> `Method of ClassSignature.t * Names.MethodName.t ] id
Sourceval source_location : (SourcePage.t * Names.DefName.t) -> [> `SourceLocation of SourcePage.t * Names.DefName.t ] id
Sourceval source_location_mod : SourcePage.t -> [> `SourceLocationMod of SourcePage.t ] id
Sourceval source_location_int : (SourcePage.t * Names.LocalName.t) -> [> `SourceLocationInternal of SourcePage.t * Names.LocalName.t ] id