package ocp-index

  1. Overview
  2. Docs
Lightweight completion and documentation browsing for OCaml libraries

Install 

dune-project
 Dependency

www.typerex.org Readme Changelog Edit opam file Versions (15)

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne
  3. K
    Kate Deplaix

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

ocp-index-1.4.1.tbz
sha256=59adbd99a9c88106dcf23bc0e3424a00f840fcedee4e4b644eaf0385ada3f911
sha512=53c9b83ee7c274bf1981de716081e4d7f603d2d4cc25c83a20d2f4c599d88d2200393feef54f4cdb25e014ea058d498ac711581c40e298df30f33a7cf8f65ff6

doc/ocp-index.lib/IndexOut/Format/index.html

Module IndexOut.FormatSource

Sourcetype coloriser = {
  1. f : 'a. IndexTypes.kind -> ('a, Format.formatter, unit) format -> Format.formatter -> 'a;
}
Sourceval color : coloriser
Sourceval no_color : coloriser
Sourceval name : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

short name of the identifier

Sourceval path : ?short:bool -> ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

fully qualified name (with short, returns the path the ident was found at, not the path where it was originally created)

Sourceval kind : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit
Sourceval ty : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit
Sourceval doc : ?escaped:bool -> ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit
Sourceval loc : ?root:string -> ?intf:bool -> ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit
Sourceval file : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit
Sourceval info : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

summary of the information

Sourceval format : ?root:string -> ?separate:bool -> string -> ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

print following a custom format string (%n,%p,%k,%t,%d,%l,%s,%f,%i are interpreted). If ~separate is set to true, escapes are formatted independently.