package ocp-index

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

Install

Dune Dependency

Authors

Maintainers

Sources

1.3.7.tar.gz
md5=8ba7ad0ff42d98e82c1359f97b98a692
sha512=54a5aad2b99126fe14e7e9c98184e58b497cbc0e5e4ac064ebaca2bec750fc5800d97edbff4cde0a323d63cd7a5e5d9942cf05467d3149fe6e3bbf03f5fe3025

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.