package reason

  1. Overview
  2. Docs
package reason
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Ast_405.DocstringsSource

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 = {
  1. docs_pre : docstring option;
  2. docs_post : docstring option;
}
Sourceval empty_docs : docs

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

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct