File: Fmt_odoc.mli

package info (click to toggle)
ocamlformat 0.27.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,068 kB
  • sloc: ml: 61,288; pascal: 4,739; lisp: 229; sh: 217; makefile: 121
file content (35 lines) | stat: -rw-r--r-- 1,440 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
(**************************************************************************)
(*                                                                        *)
(*                              OCamlFormat                               *)
(*                                                                        *)
(*            Copyright (c) Facebook, Inc. and its affiliates.            *)
(*                                                                        *)
(*      This source code is licensed under the MIT license found in       *)
(*      the LICENSE file in the root directory of this source tree.       *)
(*                                                                        *)
(**************************************************************************)

(** [offset] is the column at which the content of the comment begins. It is
    used to adjust the margin. *)
type fmt_code =
     Conf.t
  -> offset:int
  -> set_margin:bool
  -> string
  -> (Fmt.t, [`Msg of string]) Result.t

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

val fmt_parsed :
     Conf.t
  -> ?trailing_space:Fmt.t
  -> fmt_code:fmt_code
  -> input:string
  -> offset:int
  -> ( Ocamlformat_odoc_parser.Ast.t
     , Ocamlformat_odoc_parser.Warning.t list )
     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. *)