package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Refis <trefis@janestreet.com>
  2. D
    David Sheets <sheets@alum.mit.edu>
  3. L
    Leo White <leo@lpw25.net>
  4. Anton Bachin
  5. J
    Jon Ludlam <jon@recoil.org>
  6. J
    Jules Aguillon <juloo.dsi@gmail.com>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>

Maintainers

  1. J
    Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.document/Odoc_document/Url/Anchor/index.html

Module Url.Anchor

type kind = [
  1. | Path.kind
  2. | `Section
  3. | `Type
  4. | `Extension
  5. | `ExtensionDecl
  6. | `Exception
  7. | `Method
  8. | `Val
  9. | `Constructor
  10. | `Field
]
val pp_kind : Format.formatter -> kind -> unit
val string_of_kind : kind -> string
type t = {
  1. page : Path.t;
  2. anchor : string;
    (*

    Anchor in page where the element is attached

    *)
  3. kind : kind;
    (*

    What kind of element the path points to. e.g. "module", "module-type", "exception", ...

    *)
}
val from_identifier : Odoc_model.Paths.Identifier.t -> (t, Error.t) Result.result
val extension_decl : Odoc_model.Lang.Extension.t -> t

Anchor for the extension declaration item itself, which doesn't have an identifier in the model.