Something went wrong. Try again.
Odoc docs forked from jon.recoil.org/odd
Something went wrong. Try again.
12345678910111213(** Resolve an odoc reference against every package installed in the switch and render the referenced item's documentation as Markdown. *)
val doc : Switch.t -> string -> (string, [> `Msg of string ]) result(** [doc sw reference] parses [reference] (an odoc reference such as [Odoc_model.Paths.Identifier] or [Stdlib.List.map]), resolves it against the [.odoc] files of all packages documented in [sw] using the same machinery [odoc link] uses, fetches the resolved item's doc comment from its (linked) [.odocl] file, and returns it rendered as Markdown.
Errors if the reference cannot be parsed or resolved, if the owning unit cannot be loaded, or if the item carries no documentation. *)