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
  - 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
  - Indent
    
    Partial_ast
    
    Valid_ast
  - 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
  - Parse_with_comments
    
    W
  - Prec
  - Range
  - 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
  - Caml
  - Export
  - Exported_for_specific_uses
  - Fpath
    
    Map
    
    Set
  - Int_conversions
  - List
    
    Assoc
    
    Cartesian_product
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Or_unequal_lengths
  - Sexp
  - String
    
    Caseless
    
    Escaping
    
    Search_pattern
    
    Private
    
    Utf16be
    
    Utf16le
    
    Utf32be
    
    Utf32le
    
    Utf8
  - 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
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-lib.parser_recovery
- Parser_recovery
ocamlformat-lib.parser_shims
- Parser_shims
  - Clflags
  - Int
  - List
  - Misc
    
    Color
    
    Error_style
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Stdlib
    
    Array
    
    List
    
    Option
    
    String
    
    Map
    
    Set
    
    Tbl
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

val parse : 
  loc:Ocaml_common.Warnings.loc ->
  Ocamlformat_stdlib.string ->
  (Odoc_parser.Ast.t, Odoc_parser.Warning.t Ocamlformat_stdlib.list)
    Ocamlformat_stdlib.Result.t

val parse_file : 
  Stdlib.Lexing.position ->
  Ocamlformat_stdlib.string ->
  Odoc_parser.Ast.t

Used for parsing .mld files. Exceptions are caught in Translation_unit.

val warn : 
  Ocamlformat_stdlib.Format.formatter ->
  Odoc_parser.Warning.t ->
  Ocamlformat_stdlib.unit

type error =

| Moved of Ocaml_common.Location.t * Ocaml_common.Location.t * Ocamlformat_stdlib.string
| Unstable of Ocaml_common.Location.t * Ocamlformat_stdlib.string * Ocamlformat_stdlib.string
| Added of Ocaml_common.Location.t * Ocamlformat_stdlib.string
| Removed of Ocaml_common.Location.t * Ocamlformat_stdlib.string

val is_tag_only : Odoc_parser.Ast.t -> Ocamlformat_stdlib.bool

true if the documentation only contains tags

val normalize : 
  parse_docstrings:Ocamlformat_stdlib.bool ->
  normalize_code:(Ocamlformat_stdlib.string -> Ocamlformat_stdlib.string) ->
  Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.string

val normalize_text : Ocamlformat_stdlib.string -> Ocamlformat_stdlib.string

val dump : 
  Ocamlformat_stdlib.Format.formatter ->
  Odoc_parser.Ast.t ->
  Ocamlformat_stdlib.unit