package ocamlformat-lib

  1. Overview
  2. Docs
OCaml Code Formatter

Install

Dune Dependency

Authors

Maintainers

Sources

ocamlformat-0.26.2.tbz
sha256=2e4f596bf7aa367a844fe83ba0f6b0bf14b2a65179ddc082363fe9793d0375c5
sha512=b03d57462e65b11aa9f78dd5c4548251e8d1c5a1c9662f7502bdb10472aeb9df33c1d407350767a5223fbff9c01d53de85bafacd0274b49abc4b43701b159bee

doc/ocamlformat-lib.parser_standard/Parser_standard/Docstrings/WithMenhir/index.html

Module Docstrings.WithMenhirSource

Sourceval symbol_docs : (Lexing.position * Lexing.position) -> docs

Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).

Sourceval symbol_docs_lazy : (Lexing.position * Lexing.position) -> docs Lazy.t

Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).

Sourceval mark_symbol_docs : (Lexing.position * Lexing.position) -> unit

Mark the item documentation for the current symbol (for ambiguity warnings).

Sourceval mark_rhs_docs : Lexing.position -> Lexing.position -> unit

Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)

Sourceval symbol_info : Lexing.position -> info

Fetch the field info for the current symbol.

Sourceval rhs_info : Lexing.position -> info

Fetch the field info following the symbol at a given position.

Sourceval symbol_text : Lexing.position -> text

Fetch the text preceding the current symbol.

Sourceval symbol_text_lazy : Lexing.position -> text Lazy.t
Sourceval rhs_text : Lexing.position -> text

Fetch the text preceding the symbol at the given position.

Sourceval 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.

Sourceval symbol_pre_extra_text : Lexing.position -> text

Fetch additional text preceding the current symbol

Sourceval symbol_post_extra_text : Lexing.position -> text

Fetch additional text following the current symbol

Sourceval rhs_pre_extra_text : Lexing.position -> text

Fetch additional text preceding the symbol at the given position

Sourceval rhs_post_extra_text : Lexing.position -> text

Fetch additional text following the symbol at the given position

Sourceval rhs_post_text : Lexing.position -> text

Fetch text following the symbol at the given position

OCaml

Innovation. Community. Security.

On This Page
  1. Extra text