package ocaml-base-compiler
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=2d0f8090951a97a2c0e5b8a11e90096c0e1791d2e471e4a67f87e3b974044cd0
doc/compiler-libs.common/Docstrings/WithMenhir/index.html
Module Docstrings.WithMenhir
val symbol_docs : (Lexing.position * Lexing.position) -> docs
Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).
val symbol_docs_lazy : (Lexing.position * Lexing.position) -> docs Lazy.t
val rhs_docs : Lexing.position -> Lexing.position -> docs
Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).
val rhs_docs_lazy : Lexing.position -> Lexing.position -> docs Lazy.t
val mark_symbol_docs : (Lexing.position * Lexing.position) -> unit
Mark the item documentation for the current symbol (for ambiguity warnings).
val mark_rhs_docs : Lexing.position -> Lexing.position -> unit
Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)
val symbol_info : Lexing.position -> info
Fetch the field info for the current symbol.
val rhs_info : Lexing.position -> info
Fetch the field info following the symbol at a given position.
val symbol_text : Lexing.position -> text
Fetch the text preceding the current symbol.
val symbol_text_lazy : Lexing.position -> text Lazy.t
val rhs_text : Lexing.position -> text
Fetch the text preceding the symbol at the given position.
val rhs_text_lazy : Lexing.position -> text Lazy.t
Extra text
There may be additional text attached to the delimiters of a block (e.g. struct
and end
). This is fetched by the following functions, which are applied to the contents of the block rather than the delimiters.
val symbol_pre_extra_text : Lexing.position -> text
Fetch additional text preceding the current symbol
val symbol_post_extra_text : Lexing.position -> text
Fetch additional text following the current symbol
val rhs_pre_extra_text : Lexing.position -> text
Fetch additional text preceding the symbol at the given position
val rhs_post_extra_text : Lexing.position -> text
Fetch additional text following the symbol at the given position
val rhs_post_text : Lexing.position -> text
Fetch text following the symbol at the given position