package ocamlformat-lib

  1. Overview
  2. Docs
package ocamlformat-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type
type section_heading = [
  1. | `Begin_section_heading of int * string option
]
type style = [
  1. | `Bold
  2. | `Italic
  3. | `Emphasis
  4. | `Superscript
  5. | `Subscript
]
type paragraph_style = [
  1. | `Left
  2. | `Center
  3. | `Right
]
type tag = [
  1. | `Tag of [ `Author of string | `Deprecated | `Param of string | `Raise of string | `Return | `See of [ `Url | `File | `Document ] * string | `Since of string | `Before of string | `Version of string | `Canonical of string | `Children_order | `Short_title | `Inline | `Open | `Closed | `Hidden ]
]
type media = [
  1. | `Audio
  2. | `Video
  3. | `Image
]
type media_href = [
  1. | `Reference of string
]
type media_markup = [
  1. | `Simple_media of media_href * media
  2. | `Media_with_replacement_text of media_href * media * string
]
val s_of_media : [< `Replaced | `Simple ] -> [< `Audio | `Image | `Video ] -> string
type t = [
  1. | `End
  2. | `Space of string
  3. | `Single_newline of string
  4. | `Blank_line of string
  5. | `Right_brace
  6. | `Right_code_delimiter
  7. | `Word of string
  8. | `Code_span of string
  9. | `Raw_markup of string option * string
  10. | `Math_span of string
  11. | `Math_block of string
  12. | `Begin_style of style
  13. | `Begin_paragraph_style of paragraph_style
  14. | `Simple_reference of string
  15. | `Begin_reference_with_replacement_text of string
  16. | `Begin_link_with_replacement_text of string
  17. | media_markup
  18. | `Code_block of (string Loc.with_location * string Loc.with_location option) option * string * string Loc.with_location * bool
  19. | `Verbatim of string
  20. | `Modules of string
  21. | `Begin_list of [ `Unordered | `Ordered ]
  22. | `Begin_list_item of [ `Li | `Dash ]
  23. | `Begin_table_light
  24. | `Begin_table_heavy
  25. | `Begin_table_row
  26. | `Begin_table_cell of [ `Header | `Data ]
  27. | `Minus
  28. | `Plus
  29. | `Bar
  30. | section_heading
  31. | tag
]
val print : [< `Bar | `Begin_link_with_replacement_text of string & 'a | `Begin_list_item of [ `Dash | `Li ] & [< `Dash | `Li ] | `Begin_paragraph_style of paragraph_style & [< `Center | `Left | `Right ] | `Begin_reference_with_replacement_text of string & 'b | `Begin_section_heading of int * string option | `Begin_style of style & [< `Bold | `Emphasis | `Italic | `Subscript | `Superscript ] | `Begin_table_cell of [ `Data | `Header ] & [< `Data | `Header ] | `Begin_table_heavy | `Begin_table_light | `Begin_table_row | `Media_with_replacement_text of media_href * media * string & [< `Link of 'c | `Reference of 'd ] * [< `Audio | `Image | `Video ] * 'e | `Minus | `Plus | `Raw_markup of string option * string & string option * 'f | `Simple_media of media_href * media & [< `Link of 'g | `Reference of 'h ] * [< `Audio | `Image | `Video ] | `Tag of [ `Author of string | `Before of string | `Canonical of string | `Children_order | `Closed | `Deprecated | `Hidden | `Inline | `Open | `Param of string | `Raise of string | `Return | `See of [ `Document | `File | `Url ] * string | `Short_title | `Since of string | `Version of string ] & [< `Author of 'i | `Before of 'j | `Canonical of 'k | `Children_order | `Closed | `Deprecated | `Hidden | `Inline | `Open | `Param of 'l | `Raise of 'm | `Return | `See of 'n | `Short_title | `Since of 'o | `Version of 'p ] ] -> string
val describe : [< `Bar | `Begin_link_with_replacement_text of string & 'a | `Begin_list of [ `Ordered | `Unordered ] & [< `Ordered | `Unordered ] | `Begin_list_item of [ `Dash | `Li ] & [< `Dash | `Li ] | `Begin_paragraph_style of paragraph_style & [< `Center | `Left | `Right ] | `Begin_reference_with_replacement_text of string & 'b | `Begin_section_heading of int * string option & int * 'c | `Begin_style of style & [< `Bold | `Emphasis | `Italic | `Subscript | `Superscript ] | `Begin_table_cell of [ `Data | `Header ] & [< `Data | `Header ] | `Begin_table_heavy | `Begin_table_light | `Begin_table_row | `Blank_line of string & 'd | `Code_block of (string Loc.with_location * string Loc.with_location option) option * string * string Loc.with_location * bool & 'e | `Code_span of string & 'f | `Comment | `End | `Math_block of string & 'g | `Math_span of string & 'h | `Media_with_replacement_text of media_href * media * string & [< `Link of 'i | `Reference of 'j ] * [< `Audio | `Image | `Video ] * 'k | `Minus | `Modules of string & 'l | `Plus | `Raw_markup of string option * string & 'm | `Right_brace | `Right_code_delimiter | `Simple_link of string & 'n | `Simple_media of media_href * media & [< `Link of 'o | `Reference of 'p ] * [< `Audio | `Image | `Video ] | `Simple_reference of string & 'q | `Single_newline of string & 'r | `Space of string & 's | `Tag of [ `Author of string | `Before of string | `Canonical of string | `Children_order | `Closed | `Deprecated | `Hidden | `Inline | `Open | `Param of string | `Raise of string | `Return | `See of [ `Document | `File | `Url ] * string | `Short_title | `Since of string | `Version of string ] & [< `Author of 't | `Before of 'u | `Canonical of 'v | `Children_order | `Closed | `Deprecated | `Hidden | `Inline | `Open | `Param of 'w | `Raise of 'x | `Return | `See of 'y | `Short_title | `Since of 'z | `Version of 'a1 ] | `Verbatim of string & 'b1 | `Word of string ] -> string
val describe_element : [< `Heading of int * 'a * 'b | `Link of 'c | `Reference of [< `Simple | `With_text ] * 'd * 'e ] -> string
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct