package ocamlformat-mlx-lib

  1. Overview
  2. Docs
OCaml .mlx Code Formatter

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (3)

Authors

  1. A
    Andrey Popp <me@andreypopp.com>
  2. J
    Josh Berdine <jjb@fb.com>
  3. H
    Hugo Heuzard <hugo.heuzard@gmail.com>
  4. E
    Etienne Millon <etienne@tarides.com>
  5. G
    Guillaume Petiot <guillaume@tarides.com>
  6. J
    Jules Aguillon <jules@j3s.fr>

Maintainers

  1. A
    Andrey Popp <me@andreypopp.com>

Sources

ocamlformat-mlx-0.27.0.1.tbz
sha256=4557bcca3d2bd2b6d37b046a84a82a1bed83e46e45e363c0b209d30d70c0ec77
sha512=2802651c733bf3535ce9d2e4e533729da75b17e9507d911f4d79d1a68f35ddfb82db1daf8815a46d57a9937dea5b5466d523739c217ace0e446738208037ec2d

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

Module Ocamlformat_parser_extended.DocstringsSource

Sourcetype ds_attached =
  1. | Unattached
  2. | Info
  3. | Docs
Sourcetype ds_associated =
  1. | Zero
  2. | One
  3. | Many
Sourcetype 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;
}
Sourceval docstrings : docstring list ref
Sourceval warn_bad_docstrings : unit -> unit
Sourceval register : docstring -> unit
Sourceval docstring_body : docstring -> string
Sourcetype docs = {
  1. docs_pre : docstring option;
  2. docs_post : docstring option;
}
Sourceval empty_docs : docs
Sourceval add_docs_attrs : docs -> Parsetree.attribute list -> Parsetree.attribute list

add_docs_attrs but operate on ext_attrs.

Sourcetype info = docstring option
Sourceval empty_info : 'a option
Sourceval 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
Sourceval add_text_attrs : docstring list -> Parsetree.attribute list -> Parsetree.attribute list
Sourceval 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