REFERENCE.md

Reference

Table of Contents

Classes

• example: A description of the documented item, of 140 characters or fewer.

Functions

• module::examplefunc: Function description here

Classes

example

Long description of the documented item. Describe what does this class do.

Examples

Shows an example snippet of code for an object.
The first line is an optional title, and any subsequent lines are automatically formatted as a code snippet.
Use for specific examples of a given component. Use one example tag per example.

Functions

module::examplefunc

Type: Ruby 4.x API

Function description here

module::examplefunc(Type1 $param)

Function description here

Returns: Type2 Description of the return value

param

Data type: Type1

Function parameter