public class MethodDocType
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.Object> |
any |
protected java.lang.String |
commentText |
private java.lang.String |
methodName |
protected java.lang.String |
methodSignature |
protected java.util.List<ParamDocType> |
paramDoc |
private RequestDocType |
requestDoc |
private ResponseDocType |
responseDoc |
private java.lang.String |
returnDoc |
private java.lang.String |
returnTypeExample |
Constructor and Description |
---|
MethodDocType() |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.Object> |
getAny() |
java.lang.String |
getCommentText()
Gets the value of the commentText property.
|
java.lang.String |
getMethodName()
Get the method name.
|
java.lang.String |
getMethodSignature()
Get the method signature, or
null if no method signature has been set for the method. |
java.util.List<ParamDocType> |
getParamDocs() |
RequestDocType |
getRequestDoc() |
ResponseDocType |
getResponseDoc() |
java.lang.String |
getReturnDoc() |
java.lang.String |
getReturnTypeExample() |
void |
setCommentText(java.lang.String value)
Sets the value of the commentText property.
|
void |
setMethodName(java.lang.String methodName)
Set the method name.
|
void |
setMethodSignature(java.lang.String methodSignature)
Set the unique method signature, including method parameters, if any.
|
void |
setRequestDoc(RequestDocType requestDoc) |
void |
setResponseDoc(ResponseDocType responseDoc) |
void |
setReturnDoc(java.lang.String returnDoc) |
void |
setReturnTypeExample(java.lang.String returnTypeExample) |
private java.lang.String methodName
protected java.lang.String methodSignature
protected java.lang.String commentText
private java.lang.String returnDoc
private java.lang.String returnTypeExample
private RequestDocType requestDoc
private ResponseDocType responseDoc
protected java.util.List<ParamDocType> paramDoc
private java.util.List<java.lang.Object> any
public java.util.List<ParamDocType> getParamDocs()
public java.util.List<java.lang.Object> getAny()
public java.lang.String getMethodName()
public void setMethodName(java.lang.String methodName)
methodName
- the method name to set.public java.lang.String getMethodSignature()
null
if no method signature has been set for the method.
This string uniquely identifies the method in case there are multiple methods in the class with the same name.
public void setMethodSignature(java.lang.String methodSignature)
methodSignature
- method signature string to set.public java.lang.String getCommentText()
public void setCommentText(java.lang.String value)
value
- the commentTextpublic java.lang.String getReturnDoc()
public void setReturnDoc(java.lang.String returnDoc)
returnDoc
- the returnDoc to setpublic java.lang.String getReturnTypeExample()
public void setReturnTypeExample(java.lang.String returnTypeExample)
returnTypeExample
- the returnTypeExample to setpublic RequestDocType getRequestDoc()
public void setRequestDoc(RequestDocType requestDoc)
requestDoc
- the requestDoc to setpublic ResponseDocType getResponseDoc()
public void setResponseDoc(ResponseDocType responseDoc)
responseDoc
- the responseDoc to set