package ocamlformat-lib
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ddbf484c076d08f99400ee84b790ec231f5c8fcbd5d3324a6400d5388e846d15
sha512=4d2a8965a7b7ad45f8f4e76c01cf38bfa68462b07dfa7bdb2db23bd3e3017b214e6780f036679fa8595dde4167a01d957e3af8837274320449014e306773f917
doc/ocamlformat-lib.odoc_parser/Ocamlformat_odoc_parser/Odoc_parser/index.html
Module Ocamlformat_odoc_parser.Odoc_parser
Source
Parser for ocamldoc formatted comments.
type t
is the result of parsing.
parse_comment ~location ~text
parses text
as an ocamldoc formatted string. The parser will try to recover from any invalid syntax encountered, and therefore this will always produce a result without raising exceptions with zero or more warnings. The location passed in should represent the start of the content of the documentation comment - so for a line such as
(** A comment starting in the first column (0) *)
the location should represent the space immediately before the A
, so the in the 4th column (e.g. {... pos_bol=0; pos_cnum=3 }
)
Helper function to turn the internal representation of positions back into the usual representation in the Lexing module. Note that this relies on the information passed in parse_comment
, and hence requires the result of that call in addition to the Loc.point
being converted.