package ocp-index

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

1.4.0.tar.gz
md5=7224ae09fd740ce7ab7b059666e08e4b
sha512=92e6c32ae1b953ae0928e48e09dc3238a43b87165130ec85f9e73c71ea6ce38f51bc3e39768bae0eb76d06a945767a4dcbabd3a111ccf45f37b182aa16b304ad

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.

OCaml

Innovation. Community. Security.