package reason

You can search for identifiers within the package.

in-package search v0.2.0

Reason: Syntax & Toolchain for OCaml

Install

Dune Dependency

github.com Readme Edit opam file Versions (16)

Authors

J

Jordan Walke <jordojw@gmail.com>

Maintainers

J

Jordan Walke <jordojw@gmail.com>

Sources

reason-3.8.1.tbz

sha256=bfcdbb09f62b4c108f26e6dc380431613e4de4b065df8f14364efe4acea8e414

sha512=61cdf7844349b64190965782103e04eef303ca1f2a7cdc7e20d11189700796a18d2a9d9dbb3ad17eb1363bb1663113da6a22448c017820219757874601f207c3

doc/reason.ocaml-migrate-parsetree/Reason_omp/Ast_403/Docstrings/index.html

Module `Ast_403.Docstrings`Source

Docstrings

Sourcetype docstring

Documentation comments

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

Create a docstring

Sourceval docstring_body : docstring -> string

Get the text of a docstring

Sourceval docstring_loc : docstring -> Location.t

Get the location of a docstring

Items

The docs type represents documentation attached to an item.

Sourcetype docs = {

docs_pre : docstring option;
docs_post : docstring option;

}

Sourceval empty_docs : docs

Sourceval docs_attr : docstring -> Parsetree.attribute

Sourceval 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.

Sourcetype info = docstring option

Sourceval empty_info : info

Sourceval info_attr : docstring -> Parsetree.attribute

Sourceval 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.

Sourcetype text = docstring list

Sourceval empty_text : text

Sourceval text_attr : docstring -> Parsetree.attribute

Sourceval 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