Module Odoc_loader__Doc_attr
module Paths = Odoc_model.Paths
val empty : Odoc_model.Comment.docs
val attached : Paths.Identifier.LabelParent.t -> Parsetree.attributes -> Odoc_model.Comment.docs
val page : Paths.Identifier.LabelParent.t -> Location.t -> string -> Odoc_model.Comment.docs_or_stop
The parent identifier is used to define labels in the given string (i.e. for things like
{1:some_section Some title}
) and the location is used for error messages.This function is meant to be used to read arbitrary files containing text in the ocamldoc syntax.
val standalone : Paths.Identifier.LabelParent.t -> Parsetree.attribute -> Odoc_model.Comment.docs_or_stop option
val standalone_multiple : Paths.Identifier.LabelParent.t -> Parsetree.attributes -> Odoc_model.Comment.docs_or_stop list