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 (14)

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

1.3.4.tar.gz
md5=b1770f0fd784ff29173d5b4090ccff2c
sha512=32c800c404ae0f32a6cdb8f5f62bac56b23b017dd27674834e4d063df7d49bca272fc39ba2905b8404b5e3d1b154f1ffd2924705e34e1d1ac56242260b81a5c4

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

Module LibIndex.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.