package doc-ock
-
doc-ock
-
doc-ock.ocamlary
-
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
val empty : 'a DocOckTypes.Documentation.tval read_attributes :
'a DocOckPaths.Identifier.label_parent ->
('a, 'k) DocOckPaths.Identifier.t ->
Parsetree.attributes ->
'a DocOckTypes.Documentation.tval read_string :
'a DocOckPaths.Identifier.label_parent ->
Location.t ->
string ->
'a DocOckTypes.Documentation.commentThe 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 read_comment :
'a DocOckPaths.Identifier.label_parent ->
Parsetree.attribute ->
'a DocOckTypes.Documentation.comment optionval read_comments :
'a DocOckPaths.Identifier.label_parent ->
Parsetree.attributes ->
'a DocOckTypes.Documentation.comment list