package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml Documentation Generator

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (4)

Authors

Maintainers

Sources

odoc-3.1.0.tbz

sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914

sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05

doc/odoc.xref2/Odoc_xref2/Ref_tools/index.html

Module `Odoc_xref2.Ref_tools`Source

Source

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

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

Sourcetype 'a ref_result = ('a, Errors.Tools_error.reference_lookup_error) result

Source

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

Source

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

Source

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

package odoc

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.xref2/Odoc_xref2/Ref_tools/index.html

Module Odoc_xref2.Ref_toolsSource

Module `Odoc_xref2.Ref_tools`Source