Module `Odoc_xref2.Ref_tools`Source

Source

type module_lookup_result =
  Odoc_model.Paths.Reference.Resolved.Module.t
  * Odoc_xref2.Cpath.Resolved.module_
  * Odoc_xref2.Component.Module.t

Sourcetype asset_lookup_result = Odoc_model.Paths.Reference.Resolved.Asset.t

Source

type 'a ref_result =
  ('a, Odoc_xref2.Errors.Tools_error.reference_lookup_error) Stdlib.result

Source

val resolve_module_reference : 
  Odoc_xref2.Env.t ->
  Odoc_model.Paths.Reference.Module.t ->
  Odoc_xref2.Ref_tools.module_lookup_result Odoc_xref2.Ref_tools.ref_result
    Odoc_model.Error.with_warnings

Source

val resolve_asset_reference : 
  Odoc_xref2.Env.t ->
  Odoc_model.Paths.Reference.Asset.t ->
  Odoc_xref2.Ref_tools.asset_lookup_result Odoc_xref2.Ref_tools.ref_result
    Odoc_model.Error.with_warnings

Source

val resolve_reference : 
  Odoc_xref2.Env.t ->
  Odoc_model.Paths.Reference.t ->
  (Odoc_model.Paths.Reference.Resolved.t * Odoc_model.Comment.paragraph option)
    Odoc_xref2.Ref_tools.ref_result
    Odoc_model.Error.with_warnings

Module Odoc_xref2.Ref_toolsSource

Module `Odoc_xref2.Ref_tools`Source