Module `Odoc_odoc.Odoc_link`Source

Source

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

Source

val link_impl : 
  resolver:Odoc_odoc.Resolver.t ->
  filename:string ->
  Odoc_model.Lang.Implementation.t ->
  Odoc_model.Lang.Implementation.t Odoc_model.Error.with_warnings

Sourceval content_for_hidden_modules : Odoc_model.Lang.Signature.item list

Source

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

Source

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 ]) Stdlib.result

~input_warnings are the warnings stored in the input file

Source

val from_odoc : 
  resolver:Odoc_odoc.Resolver.t ->
  warnings_options:Odoc_model.Error.warnings_options ->
  warnings_tags:string list ->
  Odoc_odoc.Fs.File.t ->
  Odoc_odoc.Fs.File.t ->
  ([> `Asset of Odoc_model.Lang.Asset.t
   | `Impl of Odoc_model.Lang.Implementation.t
   | `Module of Odoc_model.Lang.Compilation_unit.t
   | `Page of Odoc_model.Lang.Page.t ],
    [> Odoc_utils.msg ])
    Stdlib.result

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

Module Odoc_odoc.Odoc_linkSource

Module `Odoc_odoc.Odoc_link`Source