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 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.

    • getDeprecatedDescription

      @Nullable public @Nullable String getDeprecatedDescription()
      The deprecated description.
      Returns:
      The deprecated description

    • setDeprecatedDescription

      public void setDeprecatedDescription(String deprecatedDescription)
      Sets the deprecated description.
      Parameters:
      deprecatedDescription - The deprecated description.