jon.recoil.org
this repo has no description
1open Odoc_model
2open Odoc_model.Paths
3
4type make_root =
5 module_name:string ->
6 digest:Digest.t ->
7 (Odoc_model.Root.t, [ `Msg of string ]) result
8
9val read_string :
10 Paths.Identifier.LabelParent.t ->
11 string ->
12 string ->
13 (Comment.docs * Frontmatter.t, Error.t) result Error.with_warnings
14
15val read_cmti :
16 make_root:make_root ->
17 parent:Identifier.ContainerPage.t option ->
18 filename:string ->
19 warnings_tag:string option ->
20 (Lang.Compilation_unit.t, Error.t) result Error.with_warnings
21
22val read_cmt :
23 make_root:make_root ->
24 parent:Identifier.ContainerPage.t option ->
25 filename:string ->
26 warnings_tag:string option ->
27 (Lang.Compilation_unit.t, Error.t) result Error.with_warnings
28
29val read_impl :
30 make_root:make_root ->
31 filename:string ->
32 source_id:Identifier.SourcePage.t option ->
33 (Lang.Implementation.t, Error.t) result Error.with_warnings
34
35val read_cmi :
36 make_root:make_root ->
37 parent:Identifier.ContainerPage.t option ->
38 filename:string ->
39 warnings_tag:string option ->
40 (Lang.Compilation_unit.t, Error.t) result Error.with_warnings
41
42val read_location : Location.t -> Location_.span
43
44val wrap_errors :
45 filename:string ->
46 (unit -> 'a) ->
47 'a Odoc_model.Error.with_errors_and_warnings
48
49val parse_attribute : Parsetree.attribute -> Doc_attr.parsed_attribute option