Odoc_loader (odoc.odoc_loader.Odoc

Sourcemodule Lookup_def : sig ... end

Sourcemodule Source_info : sig ... end

type make_root =
  module_name:string ->
  digest:Digest.t ->
  (Odoc_model.Root.t, [ `Msg of string ]) Result.result

Source

val read_string : 
  Odoc_model.Paths.Identifier.LabelParent.t ->
  string ->
  string ->
  (Odoc_model.Comment.docs_or_stop, Odoc_model.Error.t) Result.result
    Odoc_model.Error.with_warnings

Source

val read_cmt_infos : 
  filename:string ->
  (Lookup_def.t option * Source_info.local_jmp_infos, Odoc_model.Error.t)
    Result.result
    Odoc_model.Error.with_warnings

Read the shape from a .cmt file.

Source

val read_cmti : 
  make_root:make_root ->
  parent:Odoc_model.Paths.Identifier.ContainerPage.t option ->
  filename:string ->
  (Odoc_model.Lang.Compilation_unit.t, Odoc_model.Error.t) Result.result
    Odoc_model.Error.with_warnings

Source

val read_cmt : 
  make_root:make_root ->
  parent:Odoc_model.Paths.Identifier.ContainerPage.t option ->
  filename:string ->
  (Odoc_model.Lang.Compilation_unit.t
   * (Lookup_def.t option * Source_info.local_jmp_infos),
    Odoc_model.Error.t)
    Result.result
    Odoc_model.Error.with_warnings

The shape is not returned in case of a pack.

Source

val read_cmi : 
  make_root:make_root ->
  parent:Odoc_model.Paths.Identifier.ContainerPage.t option ->
  filename:string ->
  (Odoc_model.Lang.Compilation_unit.t, Odoc_model.Error.t) Result.result
    Odoc_model.Error.with_warnings

Sourceval read_location : Location.t -> Odoc_model.Location_.span