io.micronaut.openapi.javadoc

Class JavadocParser

java.lang.Object

io.micronaut.openapi.javadoc.JavadocParser

public class JavadocParser
extends java.lang.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 and Description
JavadocParser()

Method Summary

Modifier and Type	Method and Description
JavadocDescription	parse(java.lang.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 Detail

JavadocParser

public JavadocParser()

Method Detail

parse

public JavadocDescription parse(java.lang.String text)

Parse the javadoc in a JavadocDescription.

Parameters:

text - The text

Returns:

The description