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

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