package reason

  1. Overview
  2. Docs
On This Page
  1. Extra text
Reason: Syntax & Toolchain for OCaml

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (17)

Authors

  1. J
    Jordan Walke <jordojw@gmail.com>

Maintainers

  1. J
    Jordan Walke <jordojw@gmail.com>

Sources

reason-3.6.2.tgz
sha256=c4df440525581e721ec5b2c02d11e9517bf75da0e6773258793821af554ec1fa
md5=d6de40f280f1c229f9cb26eb4015f1c5

doc/reason.ocaml-migrate-parsetree/Reason_migrate_parsetree/Ast_411/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