(Re)Initialise all docstring state
val warn_bad_docstrings : unit -> unit
Emit warnings for unattached and ambiguous docstrings
Docstringsval docstring_body : docstring -> string
Get the text of a docstring
Get the location of a docstring
Set functionsThese functions are used by the lexer to associate docstrings to the locations of tokens.
Docstrings immediately preceding 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
ItemsThe docs
type represents documentation attached to an item.
Convert item documentation to attributes and add them to an attribute list
val symbol_docs : unit -> docs
Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).
val rhs_docs : int -> int -> docs
Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).
val mark_symbol_docs : unit -> unit
Mark the item documentation for the current symbol (for ambiguity warnings).
val mark_rhs_docs : int -> int -> unit
Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)
Fields and constructorsThe info
type represents documentation attached to a field or constructor.
Convert field info to attributes and add them to an attribute list
val symbol_info : unit -> info
Fetch the field info for the current symbol.
val rhs_info : int -> info
Fetch the field info following the symbol at a given position.
The text
type represents documentation which is not attached to anything.
Convert text to attributes and add them to an attribute list
val symbol_text : unit -> text
Fetch the text preceding the current symbol.
val rhs_text : int -> text
Fetch the text preceding the symbol at the given position.
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 current symbol
Fetch additional text following the current symbol
Fetch additional text preceding the symbol at the given position
Fetch additional text following the symbol at the given position
val rhs_post_text : int -> text
Fetch text following the symbol at the given position