org.codehaus.mojo.servicedocgen.descriptor

Class ExternalDocumentationDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.ExternalDocumentationDescriptor

All Implemented Interfaces:

Descriptor

public class ExternalDocumentationDescriptor
extends AbstractDescriptor

Descriptor for external documentation sources.

Author:

hohwille

Field Summary

Fields inherited from interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP_METHOD_DELETE, HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_OPTIONS, HTTP_METHOD_PATCH, HTTP_METHOD_POST, HTTP_METHOD_PUT, LOCATION_BODY, LOCATION_COOKIE, LOCATION_FORM_DATA, LOCATION_HEADER, LOCATION_PATH, LOCATION_QUERY, SCHEME_HTTP, SCHEME_HTTPS, SCHEME_WS, SCHEME_WSS, STATUS_CODE_BAD_REQUEST, STATUS_CODE_CONFLICT, STATUS_CODE_FORBIDDEN, STATUS_CODE_INTERNAL_SERVER_ERROR, STATUS_CODE_NO_CONTENT, STATUS_CODE_SUCCESS, STATUS_CODE_UNAUTHORIZED

Constructor Summary

Constructors

Constructor and Description
ExternalDocumentationDescriptor()

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getUrl()
void	setDescription(String description)
void	setUrl(String url)

Methods inherited from class org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

notNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalDocumentationDescriptor

public ExternalDocumentationDescriptor()

Method Detail

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - is the description to set

getUrl

public String getUrl()

Returns:

the url

setUrl

public void setUrl(String url)

Parameters:

url - is the url to set