Package org.springdoc.core.providers

Class SpringDocJavadocProvider

java.lang.Object

org.springdoc.core.providers.SpringDocJavadocProvider

All Implemented Interfaces:

JavadocProvider

public class SpringDocJavadocProvider
extends Object
implements JavadocProvider

The type Spring doc javadoc provider.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor	Description
SpringDocJavadocProvider()

Method Summary

Modifier and Type	Method	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 javadoc 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.

Methods inherited from class java.lang.Object

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

Constructor Details

SpringDocJavadocProvider

public SpringDocJavadocProvider()

Method Details

getClassJavadoc

public String getClassJavadoc(Class<?> cl)

Gets class description.

Specified by:

getClassJavadoc in interface JavadocProvider

Parameters:

cl - the class

Returns:

the class description

getRecordClassParamJavadoc

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

Gets param descripton of record class.

Specified by:

getRecordClassParamJavadoc in interface JavadocProvider

Parameters:

cl - the class

Returns:

map of field and param descriptions

getMethodJavadocDescription

public String getMethodJavadocDescription(Method method)

Gets method javadoc description.

Specified by:

getMethodJavadocDescription in interface JavadocProvider

Parameters:

method - the method

Returns:

the method javadoc description

getMethodJavadocReturn

public String getMethodJavadocReturn(Method method)

Gets method javadoc return.

Specified by:

getMethodJavadocReturn in interface JavadocProvider

Parameters:

method - the method

Returns:

the method javadoc return

getMethodJavadocThrows

public Map<String,String> getMethodJavadocThrows(Method method)

Gets method throws declaration.

Specified by:

getMethodJavadocThrows in interface JavadocProvider

Parameters:

method - the method

Returns:

the method throws (name-description map)

getParamJavadoc

public String getParamJavadoc(Method method,
 String name)

Gets param javadoc.

Specified by:

getParamJavadoc in interface JavadocProvider

Parameters:

method - the method

name - the name

Returns:

the param javadoc

getFieldJavadoc

public String getFieldJavadoc(Field field)

Gets field javadoc.

Specified by:

getFieldJavadoc in interface JavadocProvider

Parameters:

field - the field

Returns:

the field javadoc

getFirstSentence

public String getFirstSentence(String text)

Description copied from interface: JavadocProvider

Returns the first sentence of a javadoc comment.

Specified by:

getFirstSentence in interface JavadocProvider

Parameters:

text - the javadoc comment's text

Returns:

the first sentence based on javadoc guidelines