package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. page : string list;
    (*

    Foo.Bar.lol becomes ["lol"; "Bar"; "Foo"].

    *)
  2. anchor : string;
    (*

    Anchor in page where the element is attached

    *)
  3. kind : string;
    (*

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

    *)
}

A low level representation of ocaml paths.

val to_string : t -> string
module Error : sig ... end
val from_identifier : stop_before:bool -> Odoc_model.Paths.Identifier.t -> (t, Error.t) Result.result
val anchor_of_id_exn : Odoc_model.Paths.Identifier.t -> string
val kind_of_id_exn : Odoc_model.Paths.Identifier.t -> string
val render_path : Odoc_model.Paths.Path.t -> string
module Anchor : sig ... end
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