package ocp-index

You can search for identifiers within the package.

in-package search v0.2.0

Lightweight completion and documentation browsing for OCaml libraries

Install

Dune Dependency

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

Authors

Maintainers

L

louis.gesbert@ocamlpro.com

Sources

ocp-index-1.2.tbz

sha256=b93ed30df9ca321ff5758cdf43976034bcc5b3a23f83fcebbd524ea505e090d1

sha512=40d585edde42048d03b7672f29a0e4d0b92903d7b65f6d34f0c59d7ce29606bfc85a937b4967aea267eeb4f398990ec7ba8ec844858e433ce080a7f195a709b8

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

Module `IndexOut.Format`

type coloriser = {

f : 'a. IndexTypes.kind -> ('a, Format.formatter, unit) format -> Format.formatter -> 'a;

}

val color : coloriser

val no_color : coloriser

val name : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

short name of the identifier

val 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)

val kind : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

val ty : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

val doc : 
  ?escaped:bool ->
  ?colorise:coloriser ->
  Format.formatter ->
  IndexTypes.info ->
  unit

val loc : 
  ?root:string ->
  ?intf:bool ->
  ?colorise:coloriser ->
  Format.formatter ->
  IndexTypes.info ->
  unit

val file : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

val info : ?colorise:coloriser -> Format.formatter -> IndexTypes.info -> unit

summary of the information

val 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.