package ocamlformat-lib

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ds_attached =
  1. | Unattached
  2. | Info
  3. | Docs
type ds_associated =
  1. | Zero
  2. | One
  3. | Many
type docstring = {
  1. ds_body : string;
  2. ds_loc : Ocamlformat_ocaml_common.Location.t;
  3. mutable ds_attached : ds_attached;
  4. mutable ds_associated : ds_associated;
}
val docstrings : docstring list ref
val warn_bad_docstrings : unit -> unit
val docstring : string -> Ocamlformat_ocaml_common.Location.t -> docstring
val register : docstring -> unit
val docstring_body : docstring -> string
type docs = {
  1. docs_pre : docstring option;
  2. docs_post : docstring option;
}
val empty_docs : docs
val docs_attr : docstring -> Parsetree.attribute
val add_docs_attrs : docs -> Parsetree.attribute list -> Parsetree.attribute list
type info = docstring option
val empty_info : 'a option
val info_attr : docstring -> Parsetree.attribute
val add_info_attrs : docstring option -> Parsetree.attribute list -> Parsetree.attribute list
type text = docstring list
val empty_text : 'a list
val empty_text_lazy : 'a list lazy_t
val text_attr : docstring -> Parsetree.attribute
val add_text_attrs : docstring list -> Parsetree.attribute list -> Parsetree.attribute list
val get_docstring : info:bool -> docstring list -> docstring option
val get_docstrings : docstring list -> docstring list
val associate_docstrings : docstring list -> unit
val pre_table : (Lexing.position, docstring list) Hashtbl.t
val set_pre_docstrings : Lexing.position -> docstring list -> unit
val get_pre_docs : Lexing.position -> docstring option
val mark_pre_docs : Lexing.position -> unit
val post_table : (Lexing.position, docstring list) Hashtbl.t
val set_post_docstrings : Lexing.position -> docstring list -> unit
val get_post_docs : Lexing.position -> docstring option
val mark_post_docs : Lexing.position -> unit
val get_info : Lexing.position -> docstring option
val floating_table : (Lexing.position, docstring list) Hashtbl.t
val set_floating_docstrings : Lexing.position -> docstring list -> unit
val get_text : Lexing.position -> docstring list
val get_post_text : Lexing.position -> docstring list
val pre_extra_table : (Lexing.position, docstring list) Hashtbl.t
val set_pre_extra_docstrings : Lexing.position -> docstring list -> unit
val get_pre_extra_text : Lexing.position -> docstring list
val post_extra_table : (Lexing.position, docstring list) Hashtbl.t
val set_post_extra_docstrings : Lexing.position -> docstring list -> unit
val get_post_extra_text : Lexing.position -> docstring list
module WithParsing : sig ... end
include module type of struct include WithParsing end
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
val symbol_info : unit -> docstring option
val rhs_info : int -> docstring option
val symbol_text : unit -> docstring list
val symbol_text_lazy : unit -> docstring list lazy_t
val rhs_text : int -> docstring list
val rhs_post_text : int -> docstring list
val rhs_text_lazy : int -> docstring list lazy_t
val symbol_pre_extra_text : unit -> docstring list
val symbol_post_extra_text : unit -> docstring list
val rhs_pre_extra_text : int -> docstring list
val rhs_post_extra_text : int -> docstring list
module WithMenhir : sig ... end
val init : unit -> unit
OCaml

Innovation. Community. Security.