package odoc-parser

You can search for identifiers within the package.

in-package search v0.2.0

Parser for ocaml documentation comments

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

Anton Bachin

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-parser-1.0.1.tbz

sha256=a2bbe8e4201b60e980bab01e96e41f2ba0b05ba3f50b44f75837e8a2fb907d2c

sha512=c3339aae880ce72df866746d9ed9e7d38a752bf994ba24e948c086349604007e39602a1c31cf2ddb61ac8f8dc9dceccca43fe185850b83e3a02d75121f9ddfe2

doc/odoc-parser/Odoc_parser/index.html

Module `Odoc_parser`Source

Parser for ocamldoc formatted comments.

Sourcetype t

type t is the result of parsing.

Sourceval parse_comment : location:Lexing.position -> text:string -> t

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 })

Sourcemodule Ast : sig ... end

Abstract syntax tree representing ocamldoc comments

Sourcemodule Loc : sig ... end

Locations in files.

Sourcemodule Warning : sig ... end

Warnings produced during parsing.

Sourceval warnings : t -> Warning.t list

Extract any warnings from the parser result.

Sourceval ast : t -> Ast.t

Extract the Ast.t from the parser result.

Sourceval position_of_point : t -> Loc.point -> Lexing.position

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.