package ocamlformat-lib

You can search for identifiers within the package.

in-package search v0.2.0

ocamlformat-lib
- Ocamlformat_lib
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Ext_attrs
    
    Mod
    
    Mty
    
    Pat
    
    Token
    
    Tyd
  - Box_debug
  - Chunk
  - Cmt
  - 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
    
    Doc
    
    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-lib.format_
- Ocamlformat_format
  - Format_
ocamlformat-lib.ocaml_common
- Ocamlformat_ocaml_common
  - Location
    
    Doc
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat-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-lib.odoc_parser
- Ocamlformat_odoc_parser
  - Ast
  - Lexer
  - Loc
  - Odoc_parser
    
    Warning
  - Parse_error
  - Syntax
  - Token
  - Warning
ocamlformat-lib.parser_extended
- Ocamlformat_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
    
    C
    
    CE
    
    CT
    
    E
    
    FP
    
    Flag
    
    M
    
    MT
    
    P
    
    PVB
    
    T
  - Asttypes
  - Docstrings
    
    WithMenhir
    
    WithParsing
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Pprintast
    
    Doc
  - Printast
ocamlformat-lib.parser_shims
- Ocamlformat_parser_shims
  - Builtin_attributes
  - Clflags
  - Format_doc
    
    Doc
    
    Driver
  - Load_path
  - Misc
    
    Color
    
    Error_style
    
    Style
    
    Utf8_lexeme
ocamlformat-lib.parser_standard
- Ocamlformat_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
    
    C
    
    CE
    
    CT
    
    E
    
    M
    
    MT
    
    P
    
    PpxContext
    
    T
  - Asttypes
  - Docstrings
    
    WithMenhir
    
    WithParsing
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Pprintast
    
    Doc
  - Printast
ocamlformat-lib.stdlib_shims
- Ocamlformat_stdlib_shims
  - Bytes
  - Either
  - Int
  - List
  - String
  - Uchar

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

val create_comment : Ocamlformat_stdlib.string -> Migrate_ast.Location.t -> t

val create_docstring : Ocamlformat_stdlib.string -> Migrate_ast.Location.t -> t

val is_docstring : t -> Ocamlformat_stdlib.bool

val loc : t -> Migrate_ast.Location.t

val txt : t -> Ocamlformat_stdlib.string

include Ocamlformat_stdlib.Comparator.S with type t := t

type comparator_witness

val comparator : (t, comparator_witness) Base.Comparator.comparator

type error = {

kind : [ `Added of t | `Modified of t * t | `Dropped of t ];
cmt_kind : [ `Comment | `Doc_comment ];

}

val pp_error : 
  Ocamlformat_stdlib.Format.formatter ->
  error ->
  Ocamlformat_stdlib.unit

type pos =

| Before
| Within
| After

type decoded_kind =

| Verbatim of Ocamlformat_stdlib.string
(*
Original content.
*)
| Doc of Ocamlformat_stdlib.string
(*
Original content.
*)
| Normal of Ocamlformat_stdlib.string
(*
Original content with indentation trimmed. Trailing spaces are not removed.
*)
| Code of Ocamlformat_stdlib.string
(*
Source code with indentation removed.
*)
| Asterisk_prefixed of Ocamlformat_stdlib.string Ocamlformat_stdlib.list
(*
Line splitted with asterisks removed.
*)

type decoded = {

prefix : Ocamlformat_stdlib.string;
(*
Just after the opening.
*)
suffix : Ocamlformat_stdlib.string;
(*
Just before the closing.
*)
kind : decoded_kind;

}

val decode : parse_comments_as_doc:Ocamlformat_stdlib.bool -> t -> decoded