package ocamlformat-lib

  1. Overview
  2. Docs
Auto-formatter for OCaml code

Install

Dune Dependency

Authors

Maintainers

Sources

ocamlformat-0.26.0.tbz
sha256=031494ab770cef10a8f6aa1cbeb5660e46c3aa6c0cd457b110fec859a75e877d
sha512=35c0131f04c2c8ceb94f0f400e4b56690405ddebb482aec0c9962163001d9fd5b593455df08b508394949f2740ba28f1714dff9e1f17b618bdec62fd26fae281

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