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-project

Dependency

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

Authors

Maintainers

L

louis.gesbert@ocamlpro.com

Sources

1.2.1.tar.gz

md5=f5e0bba2b6bbdf5489f313e3c3dcdbec

sha512=82618bef74f00474dc909c01e4ba8f8e235fc420d99a1fe0bf6508745d3f0a75a0b0c25c43e89ae01aa7fb86eae667ff0e0498216881022f900d050541f7a8b5

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.