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
    
    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-lib.format_
- Format_
ocamlformat-lib.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat-lib.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Export
  - Fpath
    
    Map
    
    Set
  - List
  - Sexp
  - String
  - Warning
ocamlformat-lib.odoc_parser
- Odoc_parser
  - Ast
  - Loc
  - Warning
ocamlformat-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
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-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-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
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-lib.result
- Ocamlformat_result
  - Global_scope
  - Let_syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

Warnings produced during parsing.

type t = {

location : Loc.span;
message : string;

}

Warnings are represented as record containing the human-readable text of the warning alongside the location of the offending text in the source

val pp : Format.formatter -> t -> unit

Pretty printer for t

val to_string : t -> string

to_string will format the location and warning as text to be printed.