package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
val link_page : resolver:Resolver.t -> filename:string -> Odoc_model.Lang.Page.t -> Odoc_model.Lang.Page.t Odoc_model.Error.with_warnings
val content_for_hidden_modules : Odoc_model.Lang.Signature.item list
val handle_warnings : input_warnings:Odoc_model.Error.t list -> warnings_options:Odoc_model.Error.warnings_options -> 'a Odoc_model.Error.with_warnings -> ('b * 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 | `Source_tree of Odoc_model.Lang.SourceTree.t ], [> Or_error.msg ]) Or_error.result

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct