Documentable (de.bmiag.tapir:tapir 4.0.0 API)

All Known Implementing Classes:

TestClass, TestParameter, TestStep, TestSuite
```
public interface Documentable
```
Documentable provides some documentation.

Since:

2.0.0

Author:

Oliver Libutzki <[email protected]>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Optional<java.lang.String>`	`getDescription()`	Returns a description which is more detailed than the title.
`java.util.Optional<java.lang.String>`	`getTitle()`	Returns the title.

- Method Detail
  - getTitle
```
java.util.Optional<java.lang.String> getTitle()
```
    Returns the title. The title should be short like a headline.
    
    Returns:
    
    the optional title
    
    Since:
    
    2.0.0
  - getDescription
```
java.util.Optional<java.lang.String> getDescription()
```
    Returns a description which is more detailed than the title.
    
    Returns:
    
    the optional description
    
    Since:
    
    2.0.0