src/xref2/ref_tools.mli at main · jon.recoil.org/odoc

this repo has no description

odoc / src / xref2 / ref_tools.mli

at main 24 lines 630 B view raw

wrap content

 1open Odoc_model.Paths.Reference
 2
 3type module_lookup_result =
 4  Resolved.Module.t * Cpath.Resolved.module_ * Component.Module.t
 5
 6type asset_lookup_result = Resolved.Asset.t
 7
 8type 'a ref_result = ('a, Errors.Tools_error.reference_lookup_error) result
 9
10val resolve_module_reference :
11  Env.t ->
12  Module.t ->
13  module_lookup_result ref_result Odoc_model.Error.with_warnings
14
15val resolve_asset_reference :
16  Env.t ->
17  Asset.t ->
18  asset_lookup_result ref_result Odoc_model.Error.with_warnings
19
20val resolve_reference :
21  Env.t ->
22  t ->
23  (Resolved.t * Odoc_model.Comment.paragraph option) ref_result
24  Odoc_model.Error.with_warnings