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

1.3.3.tar.gz

md5=738dd32765ce0b6b6423620cc62b7db9

sha512=6360240c951ac64baf9b3736c9a37c41a5ac8c5ddf52e723019fb5ef294e786e245712fd88f408bd8f6881d8741ab152872181062acd81443eec07d1d703e85a

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

Module `IndexOut.Format`Source

Sourcetype coloriser = {

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

Source

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)

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

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

Source

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

Source

val 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

Source

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.

package ocp-index

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module IndexOut.FormatSource

Module `IndexOut.Format`Source