io.micronaut.openapi.javadoc

Class JavadocDescription

java.lang.Object

io.micronaut.openapi.javadoc.JavadocDescription

public class JavadocDescription
extends java.lang.Object

A parsed javadoc description.

Since:

1.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor and Description
JavadocDescription()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMethodDescription()
java.util.Map<java.lang.CharSequence,java.lang.CharSequence>	getParameters()
java.lang.String	getReturnDescription() The return description.
void	setMethodDescription(java.lang.String methodDescription) Sets the method description.
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

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.CharSequence,java.lang.CharSequence> 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.