Odoc_link (odoc.odoc_odoc.Odoc_odoc.Odoc

Source

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

Source

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

Source

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

Source

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.