Module `Ocamlformat_parser_extended.Docstrings`Source

Sourcetype ds_attached =

| Unattached
| Info
| Docs

Sourcetype ds_associated =

| Zero
| One
| Many

Sourcetype docstring = {

ds_body : string;
ds_loc : Ocamlformat_ocaml_common.Location.t;
mutable ds_attached : ds_attached;
mutable ds_associated : ds_associated;

}

Sourceval docstrings : docstring list ref

Sourceval warn_bad_docstrings : unit -> unit

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

Sourceval register : docstring -> unit

Sourceval docstring_body : docstring -> string

Sourceval docstring_loc : docstring -> Ocamlformat_ocaml_common.Location.t

Sourcetype docs = {

docs_pre : docstring option;
docs_post : docstring option;

}

Sourceval empty_docs : docs

Sourceval doc_loc : string Ocamlformat_ocaml_common.Location.loc

Sourceval docs_attr : docstring -> Parsetree.attribute

Source

val add_docs_attrs : 
  docs ->
  Parsetree.attribute list ->
  Parsetree.attribute list

Sourceval add_docs_attrs' : docs -> Parsetree.ext_attrs -> Parsetree.ext_attrs

add_docs_attrs but operate on ext_attrs.

Sourcetype info = docstring option

Sourceval empty_info : 'a option

Sourceval info_attr : docstring -> Parsetree.attribute

Source

val add_info_attrs : 
  docstring option ->
  Parsetree.attribute list ->
  Parsetree.attribute list

Sourcetype text = docstring list

Sourceval empty_text : 'a list

Sourceval empty_text_lazy : 'a list lazy_t

Sourceval text_loc : string Ocamlformat_ocaml_common.Location.loc

Sourceval text_attr : docstring -> Parsetree.attribute

Source

val add_text_attrs : 
  docstring list ->
  Parsetree.attribute list ->
  Parsetree.attribute list

Source

val add_text_attrs' : 
  docstring list ->
  Parsetree.ext_attrs ->
  Parsetree.ext_attrs

add_text_attrs but operate on ext_attrs.

Sourceval get_docstring : info:bool -> docstring list -> docstring option

Sourceval get_docstrings : docstring list -> docstring list

Sourceval associate_docstrings : docstring list -> unit

Sourceval pre_table : (Lexing.position, docstring list) Hashtbl.t

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

Sourceval get_pre_docs : Lexing.position -> docstring option

Sourceval mark_pre_docs : Lexing.position -> unit

Sourceval post_table : (Lexing.position, docstring list) Hashtbl.t

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

Sourceval get_post_docs : Lexing.position -> docstring option

Sourceval mark_post_docs : Lexing.position -> unit

Sourceval get_info : Lexing.position -> docstring option

Sourceval floating_table : (Lexing.position, docstring list) Hashtbl.t

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

Sourceval get_text : Lexing.position -> docstring list

Sourceval get_post_text : Lexing.position -> docstring list

Sourceval pre_extra_table : (Lexing.position, docstring list) Hashtbl.t

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

Sourceval get_pre_extra_text : Lexing.position -> docstring list

Sourceval post_extra_table : (Lexing.position, docstring list) Hashtbl.t

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

Sourceval get_post_extra_text : Lexing.position -> docstring list

Sourcemodule WithParsing : sig ... end

include module type of struct include WithParsing end

Sourceval symbol_docs : unit -> docs

Sourceval symbol_docs_lazy : unit -> docs lazy_t

Sourceval rhs_docs : int -> int -> docs

Sourceval rhs_docs_lazy : int -> int -> docs lazy_t

Sourceval mark_symbol_docs : unit -> unit

Sourceval mark_rhs_docs : int -> int -> unit

Sourceval symbol_info : unit -> docstring option

Sourceval rhs_info : int -> docstring option

Sourceval symbol_text : unit -> docstring list

Sourceval symbol_text_lazy : unit -> docstring list lazy_t

Sourceval rhs_text : int -> docstring list

Sourceval rhs_post_text : int -> docstring list

Sourceval rhs_text_lazy : int -> docstring list lazy_t

Sourceval symbol_pre_extra_text : unit -> docstring list

Sourceval symbol_post_extra_text : unit -> docstring list

Sourceval rhs_pre_extra_text : int -> docstring list

Sourceval rhs_post_extra_text : int -> docstring list

Sourcemodule WithMenhir : sig ... end

Sourceval init : unit -> unit

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ocamlformat-lib.parser_extended/Ocamlformat_parser_extended/Docstrings/index.html

Module `Ocamlformat_parser_extended.Docstrings`Source

package ocamlformat-lib

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ocamlformat-lib.parser_extended/Ocamlformat_parser_extended/Docstrings/index.html

Module Ocamlformat_parser_extended.DocstringsSource

Module `Ocamlformat_parser_extended.Docstrings`Source