package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
type kind = [
  1. | Path.kind
  2. | `Section
  3. | `Type
  4. | `Extension
  5. | `ExtensionDecl
  6. | `Exception
  7. | `Method
  8. | `Val
  9. | `Constructor
  10. | `Field
  11. | `SourceAnchor
]
val pp_kind : Stdlib.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.

val source_anchor : Path.t -> string -> 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