package merlin-lib

  1. Overview
  2. Docs
On This Page
  1. Extra text
Merlin's libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (12)

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.6.1-504.tbz
sha256=cc3c7c01f19a454c96f6bc8a39538023e01042519f001a895fd61488e2b49fb5
sha512=4268a932a8494023699abd98e0d52deb6f201f656863849db230dc8692050e0fe00cc25a50d70e902410f17a27268fd8335c32636f616ef012cf86fc9a43e019

doc/merlin-lib.ocaml_parsing/Ocaml_parsing/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