JavadocDescription (openapi 4.8.4 API)

java.lang.Object
- io.micronaut.openapi.javadoc.JavadocDescription

public class JavadocDescription
extends java.lang.Object

A parsed javadoc description.

Since:: 1.0

Constructor Summary

Constructors
Constructor Description

JavadocDescription()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getMethodDescription()`
`java.lang.String`	`getMethodSummary()`
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()`
`java.lang.String`	`getReturnDescription()`	The return description.
`void`	`setMethodDescription(java.lang.String methodDescription)`	Sets the method description.
`void`	`setMethodSummary(java.lang.String methodSummary)`	Sets the method summary.
`void`	`setReturnDescription(java.lang.String returnDescription)`	Sets the return description.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JavadocDescription
```
public JavadocDescription()
```
- Method Detail
  - getMethodSummary
```
public java.lang.String getMethodSummary()
```
    Returns:
    
    method summary
  - setMethodSummary
```
public void setMethodSummary(java.lang.String methodSummary)
```
    Sets the method summary.
    
    Parameters:
    
    methodSummary - The method summary
  - getMethodDescription
```
@Nullable
public java.lang.String getMethodDescription()
```
    Returns:
    
    The description
  - setMethodDescription
```
public void setMethodDescription(java.lang.String methodDescription)
```
    Sets the method description.
    
    Parameters:
    
    methodDescription - The method description
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Returns:
    
    The parameter descriptions
  - getReturnDescription
```
@Nullable
public java.lang.String getReturnDescription()
```
    The return description.
    
    Returns:
    
    The return description
  - setReturnDescription
```
public void setReturnDescription(java.lang.String returnDescription)
```
    Sets the return description.
    
    Parameters:
    
    returnDescription - The return description.