Module Ocaml_parsing.DocstringsSource

Documentation comments

Warning: this module is unstable and part of compiler-libs.

Sourceval init : unit -> unit

(Re)Initialise all docstring state

Sourceval warn_bad_docstrings : unit -> unit

Emit warnings for unattached and ambiguous docstrings

Docstrings

Sourcetype docstring

Documentation comments

Sourceval docstring : string -> Location.t -> docstring

Create a docstring

Sourceval register : docstring -> unit

Register a docstring

Sourceval docstring_body : docstring -> string

Get the text of a docstring

Sourceval docstring_loc : docstring -> Location.t

Get the location of a docstring

Set functions

These functions are used by the lexer to associate docstrings to the locations of tokens.

Sourceval set_pre_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately preceding a token

Sourceval set_post_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately following a token

Sourceval set_floating_docstrings : Lexing.position -> docstring list -> unit

Docstrings not immediately adjacent to a token

Sourceval set_pre_extra_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately following the token which precedes this one

Sourceval set_post_extra_docstrings : Lexing.position -> docstring list -> unit

Docstrings immediately preceding the token which follows this one

Items

The docs type represents documentation attached to an item.

Sourcetype docs = {
  1. docs_pre : docstring option;
  2. docs_post : docstring option;
}
Sourceval empty_docs : docs

Convert item documentation to attributes and add them to an attribute list

Sourceval symbol_docs : unit -> docs

Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).

Sourceval symbol_docs_lazy : unit -> docs Lazy.t
Sourceval rhs_docs : int -> int -> docs

Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).

Sourceval rhs_docs_lazy : int -> int -> docs Lazy.t
Sourceval mark_symbol_docs : unit -> unit

Mark the item documentation for the current symbol (for ambiguity warnings).

Sourceval mark_rhs_docs : int -> int -> unit

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.

Sourcetype info = docstring option
Sourceval empty_info : info

Convert field info to attributes and add them to an attribute list

Sourceval symbol_info : unit -> info

Fetch the field info for the current symbol.

Sourceval rhs_info : int -> info

Fetch the field info following the symbol at a given position.

Unattached comments

The text type represents documentation which is not attached to anything.

Sourcetype text = docstring list
Sourceval empty_text : text
Sourceval empty_text_lazy : text Lazy.t
Sourceval text_attr : docstring -> Parsetree.attribute
Sourceval add_text_attrs : text -> Parsetree.attributes -> Parsetree.attributes

Convert text to attributes and add them to an attribute list

Sourceval symbol_text : unit -> text

Fetch the text preceding the current symbol.

Sourceval symbol_text_lazy : unit -> text Lazy.t
Sourceval rhs_text : int -> text

Fetch the text preceding the symbol at the given position.

Sourceval rhs_text_lazy : int -> 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 : unit -> text

Fetch additional text preceding the current symbol

Sourceval symbol_post_extra_text : unit -> text

Fetch additional text following the current symbol

Sourceval rhs_pre_extra_text : int -> text

Fetch additional text preceding the symbol at the given position

Sourceval rhs_post_extra_text : int -> text

Fetch additional text following the symbol at the given position

Sourceval rhs_post_text : int -> text

Fetch text following the symbol at the given position

Sourcemodule WithMenhir : sig ... end