package ocamlformat-lib

  1. Overview
  2. Docs
OCaml Code Formatter

Install

Dune Dependency

Authors

Maintainers

Sources

ocamlformat-0.26.1.tbz
sha256=da006e427f15b9ec612fb808d446599bd9b7c3ee25abeb3d555747a70d74c6d7
sha512=b7413f8dc47ba3a2372e89d59cae54f9a602ab81e31cd14ed986a831111080b79a5a3cc45dac04d8ffae5054c35bf29fe9559f145c76c87a30e191ed5400942a

doc/ocamlformat-lib.parser_extended/Parser_extended/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