Package io.micronaut.openapi.javadoc
Class JavadocParser
- java.lang.Object
-
- io.micronaut.openapi.javadoc.JavadocParser
-
public class JavadocParser extends java.lang.ObjectVery 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
-
-
Constructor Summary
Constructors Constructor Description JavadocParser()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JavadocDescriptionparse(java.lang.String text)Parse the javadoc in aJavadocDescription.
-
-
-
Method Detail
-
parse
public JavadocDescription parse(java.lang.String text)
Parse the javadoc in aJavadocDescription.- Parameters:
text- The text- Returns:
- The description
-
-