package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

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

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.2.1.tbz
sha256=d45eb125514839fd9ac27702bb4938d1b4f3b6978e9b16ab9673ea067245affc
sha512=3555386b4770a7caa8ec903683bde5ecdc41d5e57ffaee617d5da225c747bbd1e9c1d2677f4df97e96bbdfc69f580ea83b1b92b933ea40a436a658788b677bbc

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

Module Paths.IdentifierSource

Generic operations

Sourcetype 'a id = {
  1. iv : 'a;
  2. ihash : int;
  3. ikey : string;
}
Sourcemodule type IdSig = sig ... end
Sourcemodule Id : sig ... end
Sourcemodule Any : IdSig with type t = t and type t_pv = t_pv
Sourcemodule RootModule : IdSig with type t = RootModule.t and type t_pv = RootModule.t_pv
Sourcemodule Signature : IdSig with type t = Signature.t and type t_pv = Signature.t_pv
Sourcemodule Module : IdSig with type t = Module.t and type t_pv = Module.t_pv
Sourcemodule FunctorParameter : sig ... end
Sourcemodule ModuleType : IdSig with type t = ModuleType.t and type t_pv = ModuleType.t_pv
Sourcemodule Type : IdSig with type t = Type.t and type t_pv = Type.t_pv
Sourcemodule Class : IdSig with type t = Class.t and type t_pv = Class.t_pv
Sourcemodule ClassType : IdSig with type t = ClassType.t and type t_pv = ClassType.t_pv
Sourcemodule DataType : sig ... end
Sourcemodule FieldParent : sig ... end
Sourcemodule UnboxedFieldParent : sig ... end
Sourcemodule FunctorResult : sig ... end
Sourcemodule Constructor : sig ... end
Sourcemodule Field : sig ... end
Sourcemodule UnboxedField : sig ... end
Sourcemodule Extension : sig ... end
Sourcemodule ExtensionDecl : sig ... end
Sourcemodule Exception : sig ... end
Sourcemodule Value : sig ... end
Sourcemodule Method : sig ... end
Sourcemodule InstanceVariable : sig ... end
Sourcemodule Label : IdSig with type t = Label.t and type t_pv = Label.t_pv
Sourcemodule Page : sig ... end
Sourcemodule LeafPage : sig ... end
Sourcemodule ContainerPage : sig ... end
Sourcemodule NonSrc : sig ... end
Sourcemodule SourcePage : sig ... end
Sourcemodule SourceLocation : sig ... end
Sourcemodule AssetFile : sig ... end
Sourcemodule OdocId : sig ... end
Sourcemodule Path : sig ... end
Sourcetype t = t_pv id
Sourceval hash : t -> int
Sourceval name : [< t_pv ] id -> string
Sourceval fullname : [< t_pv ] id -> string list

The fullname of value x in module M is M.x, whereas the regular name is x.

Sourceval is_hidden : [< t_pv ] id -> bool
Sourceval compare : t -> t -> int
Sourceval equal : ([< t_pv ] id as 'a) -> 'a -> bool
Sourceval label_parent : [< NonSrc.t_pv ] id -> LabelParent.t
Sourcemodule Maps : sig ... end
Sourcemodule Hashtbl : sig ... end
Sourcemodule Mk : sig ... end
Sourceval fresh_include_parent : Signature.t -> Signature.t

Create a synthetic parent identifier for items inside an include's module type expression. Uses a lowercase module name (illegal in normal OCaml) to ensure no clashes with real identifiers. Each call returns a fresh identifier.

Sourceval fresh_module_arg_parent : unit -> Signature.t

Create a synthetic parent identifier for module arguments, which can't have unique identifier, as they can be introduced multiple times with the same name in a single type expression .