package ocamlformat-lib

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Assoc : sig ... end
module Ast : sig ... end

Abstract syntax tree terms

module Chunk : sig ... end
module Cmt : sig ... end
module Cmts : sig ... end

Placing and formatting comments in a parsetree.

module Conf : sig ... end
module Conf_decl : sig ... end

This module contains ways to declare command-line and config-files options for ocamlformat. To look at declared options, see Conf.mli. To declare a new option :

module Conf_t : sig ... end

This module contains the types of configuration options, along with small helper functions. It is separated from Conf to avoid dependency cycles.

module Docstring : sig ... end
module Eol_compat : sig ... end
module Exposed : sig ... end

Predicates for determining if an AST starts/ends with a </> symbol (respectively) when printed.

module Extended_ast : sig ... end
module Fmt : sig ... end

Formatting combinators

module Fmt_ast : sig ... end

Format OCaml Ast

module Fmt_odoc : sig ... end
module Indent : sig ... end
module Literal_lexer : sig ... end
module Loc_tree : sig ... end
module Migrate_ast : sig ... end
module Multimap : sig ... end

Maps with a list of values attached to a key. This is an extension of the Map module, so these are compatible with Map.mem, etc.

module Non_overlapping_interval_tree : sig ... end

A tree of non-overlapping intervals. Intervals are non-overlapping if whenever 2 intervals share more than an end-point, then one contains the other.

module Normalize_extended_ast : sig ... end
module Normalize_std_ast : sig ... end
module Params : sig ... end
module Parse_with_comments : sig ... end
module Prec : sig ... end
module Range : sig ... end
module Source : sig ... end
module Std_ast : sig ... end

Interface over the AST defined in vendor/ocaml-4.13

module Std_longident : sig ... end
module Sugar : sig ... end
module Syntax : sig ... end
module Toplevel_lexer : sig ... end
module Translation_unit : sig ... end
module Version : sig ... end
OCaml

Innovation. Community. Security.