public interface ExternalDocumentation extends Constructible, Extensible<ExternalDocumentation>
Allows referencing an external resource for extended documentation.
| Modifier and Type | Method and Description |
|---|---|
default ExternalDocumentation |
description(java.lang.String description)
Sets this ExternalDocumentation's description property to the given string.
|
java.lang.String |
getDescription()
Returns the description property from an ExternalDocumentation instance.
|
java.lang.String |
getUrl()
Returns the url property from an ExternalDocumentation instance.
|
void |
setDescription(java.lang.String description)
Sets this ExternalDocumentation's description property to the given string.
|
void |
setUrl(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.
|
default ExternalDocumentation |
url(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.
|
addExtension, extensions, getExtensions, removeExtension, setExtensionsjava.lang.String getDescription()
void setDescription(java.lang.String description)
description - a short description of the target documentationdefault ExternalDocumentation description(java.lang.String description)
description - a short description of the target documentationjava.lang.String getUrl()
void setUrl(java.lang.String url)
url - the URL for the target documentationdefault ExternalDocumentation url(java.lang.String url)
url - the URL for the target documentation