package ocamlformat-lib
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=2e4f596bf7aa367a844fe83ba0f6b0bf14b2a65179ddc082363fe9793d0375c5
sha512=b03d57462e65b11aa9f78dd5c4548251e8d1c5a1c9662f7502bdb10472aeb9df33c1d407350767a5223fbff9c01d53de85bafacd0274b49abc4b43701b159bee
doc/ocamlformat-lib.parser_standard/Parser_standard/Docstrings/index.html
Module Parser_standard.Docstrings
Source
Documentation comments
Warning: this module is unstable and part of compiler-libs.
(Re)Initialise all docstring state
Emit warnings for unattached and ambiguous docstrings
Docstrings
Documentation comments
Create a docstring
Get the location of a docstring
Set functions
These functions are used by the lexer to associate docstrings to the locations of tokens.
Docstrings immediately preceding a token
Docstrings immediately following a token
Docstrings not immediately adjacent to a token
Docstrings immediately following the token which precedes this one
Docstrings immediately preceding the token which follows this one
Items
The docs
type represents documentation attached to an item.
Convert item documentation to attributes and add them to an attribute list
Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).
Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).
Mark the item documentation for the current symbol (for ambiguity warnings).
Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)
Fields and constructors
The info
type represents documentation attached to a field or constructor.
Convert field info to attributes and add them to an attribute list
Unattached comments
The text
type represents documentation which is not attached to anything.
Convert text to attributes and add them to an attribute list
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.
Fetch additional text preceding the symbol at the given position
Fetch additional text following the symbol at the given position