package ocamlformat-mlx-lib

You can search for identifiers within the package.

in-package search v0.2.0

ocamlformat-mlx-lib
- Ocamlformat_lib
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Mod
    
    Mty
    
    Pat
    
    Token
    
    Tyd
  - Box_debug
  - Chunk
  - Cmt
    
    Comparator_no_loc
  - Cmts
    
    Toplevel
  - Conf
    
    Elt
    
    Error
    
    Operational
    
    UI
  - Conf_decl
    
    Store
    
    UI
    
    Value
    
    Value_removed
  - Conf_t
    
    Elt
    
    Error
  - Docstring
  - Eol_compat
  - Exposed
    
    Left
    
    Right
  - Extended_ast
    
    Asttypes
    
    Parse
    
    Printast
  - Fmt
  - Fmt_ast
  - Fmt_odoc
  - Literal_lexer
  - Loc_tree
  - Migrate_ast
    
    Lexing
    
    Location
    
    Longident
    
    Position
  - Multimap
    
    M
    
    K
  - Non_overlapping_interval_tree
    
    IN
    
    Make
    
    Itv
    
    S
  - Normalize_extended_ast
  - Normalize_std_ast
  - Params
    
    Align
    
    Exp
    
    Infix_op_arg
    
    Indent
    
    Mod
    
    Pcty
  - Parse_with_comments
    
    W
  - Prec
  - Source
  - Std_ast
    
    Parse
    
    Printast
  - Std_longident
    
    String_id
  - Sugar
    
    Exp
    
    Let_binding
  - Syntax
  - Toplevel_lexer
  - Translation_unit
    
    Error
  - Version
ocamlformat-mlx-lib.format_
- Format_
ocamlformat-mlx-lib.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat-mlx-lib.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Caml
  - Export
  - Fpath
    
    Map
    
    Set
  - Int_conversions
    
    Make
    
    I
    
    Make_binary
    
    Binary
    
    I
    
    Make_hex
    
    Hex
    
    I
  - List
  - Sexp
  - String
  - Warning
ocamlformat-mlx-lib.odoc_parser
- Odoc_parser
  - Ast
  - Loc
  - Warning
ocamlformat-mlx-lib.parser_extended
- Parser_extended
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Jsx_helper
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-mlx-lib.parser_shims
- Parser_shims
  - Builtin_attributes
  - Clflags
  - Int
  - List
  - Load_path
  - Misc
    
    Color
    
    Error_style
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Stdlib
    
    Array
    
    List
    
    Option
    
    String
    
    Map
    
    Set
    
    Tbl
    
    Style
ocamlformat-mlx-lib.parser_standard
- Parser_standard
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Jsx_helper
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-mlx-lib.result
- Ocamlformat_result
  - Global_scope
  - Let_syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

Abstract syntax tree representing ocamldoc comments

This is a syntactic representation of ocamldoc comments. See The manual for a detailed description of the syntax understood. Note that there is no attempt at semantic analysis, and hence these types are capable of representing values that will be rejected by further stages, for example, invalid references or headings that are out of range.

type 'a with_location = 'a Loc.with_location

type style = [

| `Bold
| `Italic
| `Emphasis
| `Superscript
| `Subscript

]

type reference_kind = [

| `Simple
| `With_text

]

References in doc comments can be of two kinds: {!simple} or {{!ref}With text}.

type inline_element = [

| `Space of string
| `Word of string
| `Code_span of string
| `Raw_markup of string option * string
| `Styled of style * inline_element with_location list
| `Reference of reference_kind * string with_location * inline_element with_location list
| `Link of string * inline_element with_location list
| `Math_span of string
(*
- since 2.0.0
*)

]

Inline elements are equivalent to what would be found in a span in HTML. Mostly these are straightforward. The `Reference constructor takes a triple whose second element is the reference itself, and the third the replacement text. Similarly the `Link constructor has the link itself as first parameter and the second is the replacement text.

type nestable_block_element = [

| `Paragraph of inline_element with_location list
| `Code_block of (string with_location * string with_location option) option * string with_location
| `Verbatim of string
| `Modules of string with_location list
| `List of [ `Unordered | `Ordered ] * [ `Light | `Heavy ] * nestable_block_element with_location list list
| `Math_block of string
(*
- since 2.0.0
*)

]

Some block elements may be nested within lists or tags, but not all. The `List constructor has a parameter of type [`Light | `Heavy]. This corresponds to the syntactic constructor used (see the manual).

type internal_tag = [

| `Canonical of string with_location
| `Inline
| `Open
| `Closed

]

Internal tags are used to exercise fine control over the output of odoc. They are never rendered in the output

type ocamldoc_tag = [

| `Author of string
| `Deprecated of nestable_block_element with_location list
| `Param of string * nestable_block_element with_location list
| `Raise of string * nestable_block_element with_location list
| `Return of nestable_block_element with_location list
| `See of [ `Url | `File | `Document ] * string * nestable_block_element with_location list
| `Since of string
| `Before of string * nestable_block_element with_location list
| `Version of string

]

ocamldoc tags are those that are specified in the manual)

type tag = [

| ocamldoc_tag
| internal_tag

]

type heading = int * string option * inline_element with_location list

type block_element = [

| nestable_block_element
| `Heading of heading
| `Tag of tag

]

type t = block_element with_location list