package odoc
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91
doc/odoc.model/Odoc_model/Location_/index.html
Module Odoc_model.Location_
include module type of struct include Odoc_parser.Loc end
This module concerns locations in source files, both points indicating a specific character and spans between two points.
Basic types
A specific character
A range of characters between start
and end_
in a particular file
span spans
takes a list of spans and returns a single span
starting at the start of the first span and ending at the end of the final span
This adjusts only the column number, implicitly assuming that the offset does not move the location across a newline character.
Located values
Describes values located at a particular span
val at : span -> 'a -> 'a with_location
Constructor for with_location
val location : 'a with_location -> span
Returns the location of a located value
val value : 'a with_location -> 'a
Returns the value of a located value
val map : ('a -> 'b) -> 'a with_location -> 'b with_location
Map over a located value without changing its location
val same : _ with_location -> 'b -> 'b with_location
same x y
retuns the value y wrapped in a with_location
whose location is that of x
val pp : Format.formatter -> span -> unit
val pp_span_start : Format.formatter -> span -> unit