public interface ExternalDocumentation extends Constructible, Extensible
Allows referencing an external resource for extended documentation.
Modifier and Type | Method and Description |
---|---|
ExternalDocumentation |
description(String description)
Sets this ExternalDocumentation's description property to the given string.
|
String |
getDescription()
Returns the description property from an ExternalDocumentation instance.
|
String |
getUrl()
Returns the url property from an ExternalDocumentation instance.
|
void |
setDescription(String description)
Sets this ExternalDocumentation's description property to the given string.
|
void |
setUrl(String url)
Sets this ExternalDocumentation's url property to the given string.
|
ExternalDocumentation |
url(String url)
Sets this ExternalDocumentation's url property to the given string.
|
addExtension, getExtensions, setExtensions
String getDescription()
void setDescription(String description)
description
- a short description of the target documentationExternalDocumentation description(String description)
description
- a short description of the target documentationString getUrl()
void setUrl(String url)
url
- the URL for the target documentationExternalDocumentation url(String url)
url
- the URL for the target documentationCopyright © 2017–2018 Eclipse MicroProfile. All rights reserved.