Package io.micronaut.openapi.javadoc

Class JavadocParser

java.lang.Object

io.micronaut.openapi.javadoc.JavadocParser

public class JavadocParser
extends Object

Very simple javadoc parser that can used to parse out the first paragraph description and parameter / return descriptions. Most other tags are simply stripped and ignored.

Since:

1.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor	Description
JavadocParser(DocsFormat docsFormat)
JavadocParser(DocsFormat docsFormat, @Nullable io.micronaut.inject.visitor.VisitorContext context)

Method Summary

Modifier and Type	Method	Description
JavadocDescription	parse(String text)	Parse the javadoc in a JavadocDescription.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavadocParser

public JavadocParser(DocsFormat docsFormat)

JavadocParser

public JavadocParser(DocsFormat docsFormat,
 @Nullable
 @Nullable io.micronaut.inject.visitor.VisitorContext context)

Method Details

parse

public JavadocDescription parse(String text)

Parse the javadoc in a JavadocDescription.

Parameters:

text - The text

Returns:

The description