Документационные комментарии модуля

module Docstrings: sig .. end

Документационные комментарии

Предупреждение: этот модуль нестабилен и входит в состав compiler-libs.

val init : unit -> unit

(Повторно) инициализировать всё состояние документационных комментариев

val warn_bad_docstrings : unit -> unit

Вывести предупреждения о непривязанных и неоднозначных документационных комментариях

Документационные комментарии

type docstring

Документационные комментарии

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

Создать документационный комментарий

val register : docstring -> unit

Зарегистрировать документационный комментарий

val docstring_body : docstring -> string

Получить текст документационного комментария

val docstring_loc : docstring -> Location.t

Получить расположение документационного комментария

Функции установки

Эти функции используются лексером для привязки документационных комментариев к расположению токенов.

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

Документационные комментарии, непосредственно предшествующие токену

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

Документационные комментарии, непосредственно следующие за токеном

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

Документационные комментарии, не примыкающие непосредственно к токену

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

Документационные комментарии, непосредственно следующие за токеном, предшествующим этому

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

Документационные комментарии, непосредственно предшествующие токену, следующему за этим

Элементы

Тип Docstrings.docs представляет документацию, привязанную к элементу.

type docs = {

	`docs_pre : docstring option;`
	`docs_post : docstring option;`

}

val empty_docs : docs

val docs_attr : docstring -> Parsetree.attribute

val add_docs_attrs : docs -> Parsetree.attributes -> Parsetree.attributes

Преобразовать документацию элемента в атрибуты и добавить их в список атрибутов

val symbol_docs : unit -> docs

Получить документацию элемента для текущего символа. Это также помечает эту документацию (для предупреждений о неоднозначности).

val symbol_docs_lazy : unit -> docs Lazy.t

val rhs_docs : int -> int -> docs

Получить документацию элементов для символов между двумя позициями. Это также помечает эту документацию (для предупреждений о неоднозначности).

val rhs_docs_lazy : int -> int -> docs Lazy.t

val mark_symbol_docs : unit -> unit

Пометить документацию элемента для текущего символа (для предупреждений о неоднозначности).

val mark_rhs_docs : int -> int -> unit

Пометить как связанную документацию элементов для символов между двумя позициями (для предупреждений о неоднозначности)

Поля и конструкторы

Тип Docstrings.info представляет документацию, привязанную к полю или конструктору.

type info = docstring option

val empty_info : info

val info_attr : docstring -> Parsetree.attribute

val add_info_attrs : info -> Parsetree.attributes -> Parsetree.attributes

Преобразовать сведения о поле в атрибуты и добавить их в список атрибутов

val symbol_info : unit -> info

Получить сведения о поле для текущего символа.

val rhs_info : int -> info

Получить сведения о поле, следующем за символом в указанной позиции.

Непривязанные комментарии

Тип Docstrings.text представляет документацию, не привязанную ни к чему.

type text = docstring list

val empty_text : text

val empty_text_lazy : text Lazy.t

val text_attr : docstring -> Parsetree.attribute

val add_text_attrs : text -> Parsetree.attributes -> Parsetree.attributes

Преобразовать текст в атрибуты и добавить их в список атрибутов

val symbol_text : unit -> text

Получить текст, предшествующий текущему символу.

val symbol_text_lazy : unit -> text Lazy.t

val rhs_text : int -> text

Получить текст, предшествующий символу в указанной позиции.

val rhs_text_lazy : int -> text Lazy.t

Дополнительный текст

К разделителям блока может быть прикреплён дополнительный текст (например, struct и end). Этот текст получают следующие функции, применяемые к содержимому блока, а не к его разделителям.

val symbol_pre_extra_text : unit -> text

Получить дополнительный текст перед текущим символом

val symbol_post_extra_text : unit -> text

Получить дополнительный текст после текущего символа

val rhs_pre_extra_text : int -> text

Получить дополнительный текст перед символом в указанной позиции

val rhs_post_extra_text : int -> text

Получить дополнительный текст после символа в указанной позиции

val rhs_post_text : int -> text

Получить текст после символа в указанной позиции

module WithMenhir: sig .. end