public interface ExternalDocumentation extends Constructible, Extensible
Allows referencing an external resource for extended documentation.
Modifier and Type | Method and Description |
---|---|
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.
|
ExternalDocumentation |
url(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.
|
addExtension, getExtensions, setExtensions
java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- a short description of the target documentationExternalDocumentation 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 documentationExternalDocumentation url(java.lang.String url)
url
- the URL for the target documentation