org.springdoc.core.providers

Interface JavadocProvider

public interface JavadocProvider

The interface Javadoc provider.

Author:

bnasslashen

Method Summary

Modifier and Type	Method and Description
String	getClassJavadoc(Class<?> cl) Gets class description.
String	getFieldJavadoc(Field field) Gets field javadoc.
String	getFirstSentence(String text) Returns the first sentence of a javadoc comment.
String	getMethodJavadocDescription(Method method) Gets method description.
String	getMethodJavadocReturn(Method method) Gets method javadoc return.
Map<String,String>	getMethodJavadocThrows(Method method) Gets method throws declaration.
String	getParamJavadoc(Method method, String name) Gets param javadoc.
Map<String,String>	getRecordClassParamJavadoc(Class<?> cl) Gets param descripton of record class.

Method Detail

getClassJavadoc

String getClassJavadoc(Class<?> cl)

Gets class description.

Parameters:

cl - the class

Returns:

the class description

getRecordClassParamJavadoc

Map<String,String> getRecordClassParamJavadoc(Class<?> cl)

Gets param descripton of record class.

Parameters:

cl - the class

Returns:

map of field and param descriptions

getMethodJavadocDescription

String getMethodJavadocDescription(Method method)

Gets method description.

Parameters:

method - the method

Returns:

the method description

getMethodJavadocReturn

String getMethodJavadocReturn(Method method)

Gets method javadoc return.

Parameters:

method - the method

Returns:

the method javadoc return

getMethodJavadocThrows

Map<String,String> getMethodJavadocThrows(Method method)

Gets method throws declaration.

Parameters:

method - the method

Returns:

the method throws (name-description map)

getParamJavadoc

String getParamJavadoc(Method method,
                       String name)

Gets param javadoc.

Parameters:

method - the method

name - the name

Returns:

the param javadoc

getFieldJavadoc

String getFieldJavadoc(Field field)

Gets field javadoc.

Parameters:

field - the field

Returns:

the field javadoc

getFirstSentence

String getFirstSentence(String text)

Returns the first sentence of a javadoc comment.

Parameters:

text - the javadoc comment's text

Returns:

the first sentence based on javadoc guidelines