package doc-ock-html

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = {

page : string list;
(*
Foo.Bar.lol becomes ["lol"; "Bar"; "Foo"].
*)
anchor : string;
(*
Anchor in page where the element is attached
*)
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 : 
  get_package:('pkg -> string) ->
  stop_before:bool ->
  ('pkg, _) DocOck.Paths.Identifier.t ->
  (t, Error.t) Stdlib.result

val anchor_of_id_exn : 
  get_package:('pkg -> string) ->
  ('pkg, _) DocOck.Paths.Identifier.t ->
  string

val kind_of_id_exn : 
  get_package:('pkg -> string) ->
  ('pkg, _) DocOck.Paths.Identifier.t ->
  string

val render_path : (_, _) DocOck.Paths.Path.t -> string

module Anchor : sig ... end