package ocaml-migrate-parsetree

You can search for identifiers within the package.

in-package search v0.2.0

Convert OCaml parsetrees between different versions

Install

Dune Dependency

github.com Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (16)

Authors

Maintainers

F

frederic.bour@lakaban.net

Sources

ocaml-migrate-parsetree-v1.8.0.tbz

sha256=b1c2d176ff1444041f2775786ba605be796e46dfd2acb06c96f35d2bb88b8fb5

sha512=c14ffacbba9fda34243b3e8310ce49414415b530bbd982eaa6c1891517c5a9a6a35887afa7d6f15f7f94e225a7f15cc25417fd3337e685d4a7d6ee160e50e66e

doc/ocaml-migrate-parsetree/Ast_405/Docstrings/index.html

Module `Ast_405.Docstrings`

Docstrings

type docstring

Documentation comments

val docstring : string -> Location.t -> docstring

Create a docstring

val docstring_body : docstring -> string

Get the text of a docstring

val docstring_loc : docstring -> Location.t

Get the location of a docstring

Items

The docs type represents documentation attached to an item.

type docs = {

docs_pre : docstring option;
docs_post : docstring option;

}

val empty_docs : docs

val docs_attr : docstring -> Parsetree.attribute

val add_docs_attrs : docs -> Parsetree.attributes -> Parsetree.attributes

Convert item documentation to attributes and add them to an attribute list

Fields and constructors

The info type represents documentation attached to a field or constructor.

type info = docstring option

val empty_info : info

val info_attr : docstring -> Parsetree.attribute

val add_info_attrs : info -> Parsetree.attributes -> Parsetree.attributes

Convert field info to attributes and add them to an attribute list

Unattached comments

The text type represents documentation which is not attached to anything.

type text = docstring list

val empty_text : text

val text_attr : docstring -> Parsetree.attribute

val add_text_attrs : text -> Parsetree.attributes -> Parsetree.attributes

Convert text to attributes and add them to an attribute list

On This Page

Docstrings
Items
Fields and constructors
Unattached comments