Fmt_odoc (p.ocamlformat-mlx-lib.0.28.1.1.doc.ocamlformat-mlx-lib.Ocamlformat_lib.Fmt

Source

type fmt_code =
  Conf.t ->
  offset:Ocamlformat_stdlib.int ->
  set_margin:Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.string ->
  (Fmt.t, [ `Msg of Ocamlformat_stdlib.string ]) Ocamlformat_stdlib.Result.t

offset is the column at which the content of the comment begins. It is used to adjust the margin.

Source

val fmt_ast : 
  Conf.t ->
  fmt_code:fmt_code ->
  Ocamlformat_odoc_parser.Ast.t ->
  Fmt.t

Source

val fmt_parsed : 
  Conf.t ->
  ?trailing_space:Fmt.t ->
  fmt_code:fmt_code ->
  input:Ocamlformat_stdlib.string ->
  offset:Ocamlformat_stdlib.int ->
  (Ocamlformat_odoc_parser.Ast.t,
    Ocamlformat_odoc_parser.Warning.t Ocamlformat_stdlib.list)
    Ocamlformat_stdlib.Result.t ->
  Fmt.t

source is the global source in which the locations in the AST make sense. input is the content of the doc-comment.