package mdx

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

type docstring

Documentation comments

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

Create a docstring

val docstring_body : docstring -> string

Get the text of a docstring

val docstring_loc : docstring -> Ast_406.Location.t

Get the location of a docstring

The docs type represents documentation attached to an item.

type docs = {

}

val empty_docs : docs

val docs_attr : docstring -> Ast_406.Parsetree.attribute

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

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

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

type info = docstring option

val empty_info : info

val info_attr : docstring -> Ast_406.Parsetree.attribute

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

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

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

type text = docstring list

val empty_text : text

val text_attr : docstring -> Ast_406.Parsetree.attribute

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

Convert text to attributes and add them to an attribute list