Package io.micronaut.openapi.javadoc

Class JavadocDescription

java.lang.Object

io.micronaut.openapi.javadoc.JavadocDescription

public class JavadocDescription
extends Object

A parsed javadoc description.

Since:

1.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor	Description
JavadocDescription()

Method Summary

Modifier and Type	Method	Description
@Nullable String	getMethodDescription()
String	getMethodSummary()
Map<String,String>	getParameters()
@Nullable String	getReturnDescription()	The return description.
void	setMethodDescription(String methodDescription)	Sets the method description.
void	setMethodSummary(String methodSummary)	Sets the method summary.
void	setReturnDescription(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 Details

JavadocDescription

public JavadocDescription()

Method Details

getMethodSummary

public String getMethodSummary()

Returns:

method summary

setMethodSummary

public void setMethodSummary(String methodSummary)

Sets the method summary.

Parameters:

methodSummary - The method summary

getMethodDescription

@Nullable
public @Nullable String getMethodDescription()

Returns:

The description

setMethodDescription

public void setMethodDescription(String methodDescription)

Sets the method description.

Parameters:

methodDescription - The method description

getParameters

public Map<String,String> getParameters()

Returns:

The parameter descriptions

getReturnDescription

@Nullable
public @Nullable String getReturnDescription()

The return description.

Returns:

The return description

setReturnDescription

public void setReturnDescription(String returnDescription)

Sets the return description.

Parameters:

returnDescription - The return description.