package doc-ock

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val empty : 'a DocOck__.DocOckTypes.Documentation.t
val read_attributes : ('a, [ DocOck__.DocOckPaths.Kind.signature | DocOck__.DocOckPaths.Kind.class_signature | DocOck__.DocOckPaths.Kind.datatype ]) DocOck__.DocOckPaths.Identifier.t -> ('a, 'k) DocOck__.DocOckPaths.Identifier.t -> Parsetree.attributes -> 'a DocOck__.DocOckTypes.Documentation.t
val read_string : ('a, [ DocOck__.DocOckPaths.Kind.signature | DocOck__.DocOckPaths.Kind.class_signature | DocOck__.DocOckPaths.Kind.datatype ]) DocOck__.DocOckPaths.Identifier.t -> Location.t -> string -> 'a DocOck__.DocOckTypes.Documentation.comment

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 read_comment : ('a, [ DocOck__.DocOckPaths.Kind.signature | DocOck__.DocOckPaths.Kind.class_signature | DocOck__.DocOckPaths.Kind.datatype ]) DocOck__.DocOckPaths.Identifier.t -> Parsetree.attribute -> 'a DocOck__.DocOckTypes.Documentation.comment option
val read_comments : ('a, [ DocOck__.DocOckPaths.Kind.signature | DocOck__.DocOckPaths.Kind.class_signature | DocOck__.DocOckPaths.Kind.datatype ]) DocOck__.DocOckPaths.Identifier.t -> Parsetree.attributes -> 'a DocOck__.DocOckTypes.Documentation.comment list
OCaml

Innovation. Community. Security.