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 (24)

Authors

Maintainers

Sources

odoc-3.0.0.tbz

sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b

sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

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

Source

type 'a ref_result =
  ('a, Errors.Tools_error.reference_lookup_error) Result.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