package doc-ock

  1. Overview
  2. Docs
package doc-ock
Legend:
Library
Module
Module type
Parameter
Class
Class type

Paths of documentation

Sexp serialization

type sexp =
  1. | List of sexp list
  2. | Atom of string
val string_of_sexp : sexp -> string

Paths

module Kind : sig ... end

Every path is annotated with its kind.

module Identifier : sig ... end

Identifiers for definitions

module Path : sig ... end

Normal OCaml paths (i.e. the ones present in types)

module Fragment : sig ... end

OCaml path fragments for specifying module substitutions

module Reference : sig ... end

References present in documentation comments ({!Foo.Bar})