Documented

All Superinterfaces:

Exportable

All Known Implementing Classes:

Action.Template, Channel, Destination.Template, Endpoint.Template, Origin.Template, Parameter, Relationship, Template
```
public interface Documented
extends Exportable
```
Provides basic documentation about a class instance so that it can be exposed to the end user. Documented classes must also be Exportable to provide a representation of the instance to the user.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.lang.String`	`description()`	Returns a longer description of this class instance.
`default Data`	`export()`	Renders this class instance to a simple data structure for rendering client-side.
`java.lang.String`	`name()`	Returns the friendly name of this instance.
`java.lang.String`	`summary()`	Returns the short summary about this class instance

- Method Detail
  - name
```
java.lang.String name()
```
    Returns the friendly name of this instance. Ideally this should be unique.
    
    Returns:
    
    the instance name
  - summary
```
java.lang.String summary()
```
    Returns the short summary about this class instance
    
    Returns:
    
    the summary text
  - description
```
java.lang.String description()
```
    Returns a longer description of this class instance. Per convention, the description may contain markdown to organize the content in a structured way for the user.
    See: https://en.wikipedia.org/wiki/Markdown and https://www.markdownguide.org/
    
    Returns:
    
    the description markdown text
  - export
```
default Data export()
```
    Description copied from interface: Exportable
    
    Renders this class instance to a simple data structure for rendering client-side.
    
    Specified by:
    
    export in interface Exportable
    
    Returns:
    
    a public data representation of this class instance