Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
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.