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 ISC License Edit opam file Versions (3)

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.odoc/Odoc_odoc/Odoc_link/index.html

Module `Odoc_odoc.Odoc_link`

val link_page : 
  resolver:Resolver.t ->
  filename:string ->
  Odoc_model.Lang.Page.t ->
  Odoc_model.Lang.Page.t Odoc_model.Error.with_warnings

val link_unit : 
  resolver:Resolver.t ->
  filename:string ->
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_model.Lang.Compilation_unit.t Odoc_model.Error.with_warnings

val handle_warnings : 
  input_warnings:Odoc_model.Error.t list ->
  warnings_options:Odoc_model.Error.warnings_options ->
  'a Odoc_model.Error.with_warnings ->
  ('a * Odoc_model.Error.t list, [> `Msg of string ]) Or_error.result

~input_warnings are the warnings stored in the input file

val from_odoc : 
  resolver:Resolver.t ->
  warnings_options:Odoc_model.Error.warnings_options ->
  Fs.File.t ->
  Fs.File.t ->
  ([> `Module of Odoc_model.Lang.Compilation_unit.t
   | `Page of Odoc_model.Lang.Page.t ],
    [> Or_error.msg ])
    Or_error.result

Read the input file and write to the output file. Also return the resulting tree.