File: Docstring.mli

package info (click to toggle)
ocamlformat 0.28.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,436 kB
  • sloc: ml: 63,321; pascal: 4,769; lisp: 229; sh: 217; makefile: 121
file content (36 lines) | stat: -rw-r--r-- 1,481 bytes parent folder | download | duplicates (2)
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
36
(**************************************************************************)
(*                                                                        *)
(*                              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.       *)
(*                                                                        *)
(**************************************************************************)

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

val parse_file : Lexing.position -> string -> Ocamlformat_odoc_parser.Ast.t
(** Used for parsing [.mld] files. Exceptions are caught in
    [Translation_unit]. *)

val warn : Format.formatter -> Ocamlformat_odoc_parser.Warning.t -> unit

val is_tag_only : Ocamlformat_odoc_parser.Ast.t -> bool
(** [true] if the documentation only contains tags *)

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

val normalize_text : string -> string

val dump : Format.formatter -> Ocamlformat_odoc_parser.Ast.t -> unit